xref: /petsc/include/petscsnes.h (revision b79b07cfcefae6db9a29cf138c901e6c3b8d1456)
1f26ada1bSBarry Smith /*
2eef9c623SLois Curfman McInnes     User interface for the nonlinear solvers package.
3f26ada1bSBarry Smith */
40a835dfdSSatish Balay #if !defined(__PETSCSNES_H)
50a835dfdSSatish Balay #define __PETSCSNES_H
694b7f48cSBarry Smith #include "petscksp.h"
7e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
8b1f5cb9dSBarry Smith 
9435da068SBarry Smith /*S
10435da068SBarry Smith      SNES - Abstract PETSc object that manages all nonlinear solves
11435da068SBarry Smith 
12435da068SBarry Smith    Level: beginner
13435da068SBarry Smith 
14435da068SBarry Smith   Concepts: nonlinear solvers
15435da068SBarry Smith 
1694b7f48cSBarry Smith .seealso:  SNESCreate(), SNESSetType(), SNESType, TS, KSP, KSP, PC
17435da068SBarry Smith S*/
18f09e8eb9SSatish Balay typedef struct _p_SNES* SNES;
19435da068SBarry Smith 
20435da068SBarry Smith /*E
21435da068SBarry Smith     SNESType - String with the name of a PETSc SNES method or the creation function
22435da068SBarry Smith        with an optional dynamic library name, for example
23435da068SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mysnescreate()
24435da068SBarry Smith 
25435da068SBarry Smith    Level: beginner
26435da068SBarry Smith 
27435da068SBarry Smith .seealso: SNESSetType(), SNES
28435da068SBarry Smith E*/
29a313700dSBarry Smith #define SNESType char*
30eef9c623SLois Curfman McInnes #define SNESLS      "ls"
31eef9c623SLois Curfman McInnes #define SNESTR      "tr"
321d6018f0SLisandro Dalcin #define SNESPYTHON  "python"
33eef9c623SLois Curfman McInnes #define SNESTEST    "test"
34070915c3SMatthew G Knepley #define SNESPICARD  "picard"
35*b79b07cfSJed Brown #define SNESKSPONLY "ksponly"
36b1f5cb9dSBarry Smith 
37deeb6e72SMatthew Knepley /* Logging support */
380700a824SBarry Smith extern PetscClassId PETSCSNES_DLLEXPORT SNES_CLASSID;
39deeb6e72SMatthew Knepley 
4063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESInitializePackage(const char[]);
41deeb6e72SMatthew Knepley 
4263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESCreate(MPI_Comm,SNES*);
4363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDestroy(SNES);
44a313700dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetType(SNES,const SNESType);
45a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void*));
46a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorCancel(SNES);
4763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscTruth);
4863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
4970e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUp(SNES);
50f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSolve(SNES,Vec,Vec);
5184cb2905SBarry Smith 
5263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
534d8f6ca9SMatthew Knepley 
5463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
5563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultUpdate(SNES, PetscInt);
564d8f6ca9SMatthew Knepley 
57b0a32e0cSBarry Smith extern PetscFList SNESList;
5863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterDestroy(void);
5963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterAll(const char[]);
6084cb2905SBarry Smith 
6163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES));
6230de9b25SBarry Smith 
6330de9b25SBarry Smith /*MC
6430de9b25SBarry Smith    SNESRegisterDynamic - Adds a method to the nonlinear solver package.
6530de9b25SBarry Smith 
6630de9b25SBarry Smith    Synopsis:
671890ba74SBarry Smith    PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES))
6830de9b25SBarry Smith 
6930de9b25SBarry Smith    Not collective
7030de9b25SBarry Smith 
7130de9b25SBarry Smith    Input Parameters:
7230de9b25SBarry Smith +  name_solver - name of a new user-defined solver
7330de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
7430de9b25SBarry Smith .  name_create - name of routine to create method context
7530de9b25SBarry Smith -  routine_create - routine to create method context
7630de9b25SBarry Smith 
7730de9b25SBarry Smith    Notes:
7830de9b25SBarry Smith    SNESRegisterDynamic() may be called multiple times to add several user-defined solvers.
7930de9b25SBarry Smith 
8030de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
8130de9b25SBarry Smith    is ignored.
8230de9b25SBarry Smith 
83ab901514SBarry Smith    Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
8430de9b25SBarry Smith    and others of the form ${any_environmental_variable} occuring in pathname will be
8530de9b25SBarry Smith    replaced with appropriate values.
8630de9b25SBarry Smith 
8730de9b25SBarry Smith    Sample usage:
8830de9b25SBarry Smith .vb
8930de9b25SBarry Smith    SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a,
9030de9b25SBarry Smith                 "MySolverCreate",MySolverCreate);
9130de9b25SBarry Smith .ve
9230de9b25SBarry Smith 
9330de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
9430de9b25SBarry Smith $     SNESSetType(snes,"my_solver")
9530de9b25SBarry Smith    or at runtime via the option
9630de9b25SBarry Smith $     -snes_type my_solver
9730de9b25SBarry Smith 
9830de9b25SBarry Smith    Level: advanced
9930de9b25SBarry Smith 
10030de9b25SBarry Smith     Note: If your function is not being put into a shared library then use SNESRegister() instead
10130de9b25SBarry Smith 
10230de9b25SBarry Smith .keywords: SNES, nonlinear, register
10330de9b25SBarry Smith 
10430de9b25SBarry Smith .seealso: SNESRegisterAll(), SNESRegisterDestroy()
10530de9b25SBarry Smith M*/
106aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
107f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0)
108b2002411SLois Curfman McInnes #else
109f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d)
110b2002411SLois Curfman McInnes #endif
111b2002411SLois Curfman McInnes 
11263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetKSP(SNES,KSP*);
1132999313aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetKSP(SNES,KSP);
11463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolution(SNES,Vec*);
11563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolutionUpdate(SNES,Vec*);
11670e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunction(SNES,Vec*,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
11763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESView(SNES,PetscViewer);
1187bc3d0afSSatish Balay 
11963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetOptionsPrefix(SNES,const char[]);
12063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAppendOptionsPrefix(SNES,const char[]);
12119dca363SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetOptionsPrefix(SNES,const char*[]);
12263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFromOptions(SNES);
12340191667SLois Curfman McInnes 
124fef1beadSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatCreateSNESMF(SNES,Mat*);
125e884886fSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
1268f6e3e37SBarry Smith 
12763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatDAADSetSNES(Mat,SNES);
1283a7fca6bSBarry Smith 
129a313700dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetType(SNES,const SNESType*);
130a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
131b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
132a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
133d86576fbSMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSetRatio(SNES,PetscViewerASCIIMonitor);
134a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
135a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
136a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
137a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
13863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
13963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
14063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTrustRegionTolerance(SNES,PetscReal);
14171f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunctionNorm(SNES,PetscReal*);
142b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetIterationNumber(SNES,PetscInt*);
1433d4c4710SBarry Smith 
144b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNonlinearStepFailures(SNES,PetscInt*);
145b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
146b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
1472541af92SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberFunctionEvals(SNES,PetscInt*);
148b850b91aSLisandro Dalcin 
149a8054027SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetLagPreconditioner(SNES,PetscInt);
150a8054027SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLagPreconditioner(SNES,PetscInt*);
151e35cf81dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetLagJacobian(SNES,PetscInt);
152e35cf81dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLagJacobian(SNES,PetscInt*);
153a8054027SBarry Smith 
154b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveIterations(SNES,PetscInt*);
1553d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveFailures(SNES,PetscInt*);
1563d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxLinearSolveFailures(SNES,PetscInt);
1573d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
1583d4c4710SBarry Smith 
159fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPSetUseEW(SNES,PetscTruth);
160fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPGetUseEW(SNES,PetscTruth*);
161fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
162fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
163eafb4bcbSBarry Smith 
164a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
165a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLG(SNES,PetscInt,PetscReal,void*);
166a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGDestroy(PetscDrawLG);
167b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRangeCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
168b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
169b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRangeDestroy(PetscDrawLG);
170eafb4bcbSBarry Smith 
17163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetApplicationContext(SNES,void *);
17263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetApplicationContext(SNES,void **);
173184914b5SBarry Smith 
1741d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESPythonSetType(SNES,const char[]);
1751d6018f0SLisandro Dalcin 
1764936397dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunctionDomainError(SNES);
177435da068SBarry Smith /*E
178435da068SBarry Smith     SNESConvergedReason - reason a SNES method was said to
179435da068SBarry Smith          have converged or diverged
180435da068SBarry Smith 
181435da068SBarry Smith    Level: beginner
182435da068SBarry Smith 
183f203c74bSBarry Smith    The two most common reasons for divergence are
184f203c74bSBarry Smith $   1) an incorrectly coded or computed Jacobian or
185f203c74bSBarry Smith $   2) failure or lack of convergence in the linear system (in this case we recommend
186f203c74bSBarry Smith $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
187f203c74bSBarry Smith 
188f203c74bSBarry Smith    Diverged Reasons:
189f203c74bSBarry Smith .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
190f203c74bSBarry Smith        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
191f203c74bSBarry Smith        at Q'(alpha) = s^T F'(x+alpha s)^T F(x+alpha s) = 0. If s is the Newton direction - F'(x)^(-1)F(x) then
192f203c74bSBarry Smith        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
193f203c74bSBarry Smith        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
194f203c74bSBarry Smith        direction is a descent direction and the line search should succeed if alpha is small enough.
195f203c74bSBarry Smith 
196f203c74bSBarry Smith        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
197f203c74bSBarry Smith        is NOT a descent direction so the line search will fail. All one can do at this point
198f203c74bSBarry Smith        is change the initial guess and try again.
199f203c74bSBarry Smith 
200f203c74bSBarry Smith        An alternative explanation: Newton's method can be regarded as replacing the function with
201f203c74bSBarry Smith        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
202f203c74bSBarry Smith        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
203f203c74bSBarry Smith        s = - F'(x)^(-1)F(x) otherwise F'(x)^T F'(x) s = -F'(x)^T F(x). If F'(x)^T F(x) is NOT zero then there
204f203c74bSBarry Smith        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
205f203c74bSBarry Smith        s = - [F'(x)^T F'(x)]^(-1) F'(x)^T F(x) so Q'(0) = - F(x)^T F'(x) [F'(x)^T F'(x)]^(-T) F'(x)^T F(x)
206f203c74bSBarry Smith        = - (F'(x)^T F(x)) [F'(x)^T F'(x)]^(-T) (F'(x)^T F(x)). Since we are assuming (F'(x)^T F(x)) != 0
207f203c74bSBarry Smith        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
208f203c74bSBarry Smith        search should succeed for small enough alpha.
209f203c74bSBarry Smith 
210f203c74bSBarry Smith        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
211f203c74bSBarry Smith        (well enough?) or the Jacobian is wrong.
212f203c74bSBarry Smith 
2134d0a8057SBarry Smith    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
2144d0a8057SBarry Smith    convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test;
2154d0a8057SBarry Smith    thus the usual convergence criteria have not been checked and may or may not be satisfied.
216f203c74bSBarry Smith 
2174d0a8057SBarry Smith    Developer Notes: this must match finclude/petscsnes.h
2184d0a8057SBarry Smith 
2194d0a8057SBarry Smith        The string versions of these are in SNESConvergedReason, if you change any value here you must
2204d0a8057SBarry Smith      also adjust that array.
2215968eb51SBarry Smith 
22246a9e3ceSBarry Smith    Each reason has its own manual page.
22346a9e3ceSBarry Smith 
224435da068SBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
225435da068SBarry Smith E*/
226184914b5SBarry Smith typedef enum {/* converged */
22701b82886SBarry Smith               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
22801b82886SBarry Smith               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
22946a9e3ceSBarry Smith               SNES_CONVERGED_PNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol */
2303f149594SLisandro Dalcin               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
231184914b5SBarry Smith               SNES_CONVERGED_TR_DELTA          =  7,
232184914b5SBarry Smith               /* diverged */
23346a9e3ceSBarry Smith               SNES_DIVERGED_FUNCTION_DOMAIN    = -1, /* the new x location passed the function is not in the domain of F */
234184914b5SBarry Smith               SNES_DIVERGED_FUNCTION_COUNT     = -2,
23546a9e3ceSBarry Smith               SNES_DIVERGED_LINEAR_SOLVE       = -3, /* the linear solve failed */
236184914b5SBarry Smith               SNES_DIVERGED_FNORM_NAN          = -4,
237184914b5SBarry Smith               SNES_DIVERGED_MAX_IT             = -5,
23846a9e3ceSBarry Smith               SNES_DIVERGED_LS_FAILURE         = -6, /* the line search failed */
23958c775ebSBarry Smith               SNES_DIVERGED_LOCAL_MIN          = -8, /* || J^T b || is small, implies converged to local minimum of F() */
240184914b5SBarry Smith               SNES_CONVERGED_ITERATING         =  0} SNESConvergedReason;
2419dcbbd2bSBarry Smith extern const char **SNESConvergedReasons;
242184914b5SBarry Smith 
243c838673bSBarry Smith /*MC
244c838673bSBarry Smith      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
245c838673bSBarry Smith 
246c838673bSBarry Smith    Level: beginner
247c838673bSBarry Smith 
248c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
249c838673bSBarry Smith 
250c838673bSBarry Smith M*/
251c838673bSBarry Smith 
252c838673bSBarry Smith /*MC
253c838673bSBarry Smith      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
254c838673bSBarry Smith 
255c838673bSBarry Smith    Level: beginner
256c838673bSBarry Smith 
257c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
258c838673bSBarry Smith 
259c838673bSBarry Smith M*/
260c838673bSBarry Smith 
261c838673bSBarry Smith /*MC
26246a9e3ceSBarry Smith      SNES_CONVERGED_PNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
26346a9e3ceSBarry Smith           solution and stol is the 4th argument to SNESSetTolerances()
264c838673bSBarry Smith 
265c838673bSBarry Smith    Level: beginner
266c838673bSBarry Smith 
267c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
268c838673bSBarry Smith 
269c838673bSBarry Smith M*/
270c838673bSBarry Smith 
271c838673bSBarry Smith /*MC
272c838673bSBarry Smith      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
273c838673bSBarry Smith          argument to SNESSetTolerances()
274c838673bSBarry Smith 
275c838673bSBarry Smith    Level: beginner
276c838673bSBarry Smith 
277c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
278c838673bSBarry Smith 
279c838673bSBarry Smith M*/
280c838673bSBarry Smith 
281c838673bSBarry Smith /*MC
282c838673bSBarry Smith      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
283c838673bSBarry Smith       is usually caused by a division of 0 by 0.
284c838673bSBarry Smith 
285c838673bSBarry Smith    Level: beginner
286c838673bSBarry Smith 
287c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
288c838673bSBarry Smith 
289c838673bSBarry Smith M*/
290c838673bSBarry Smith 
291c838673bSBarry Smith /*MC
292c838673bSBarry Smith      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
293c838673bSBarry Smith 
294c838673bSBarry Smith    Level: beginner
295c838673bSBarry Smith 
296c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
297c838673bSBarry Smith 
298c838673bSBarry Smith M*/
299c838673bSBarry Smith 
300c838673bSBarry Smith /*MC
301c838673bSBarry Smith      SNES_DIVERGED_LS_FAILURE - The line search has failed. This only occurs for a SNESType of SNESLS
302c838673bSBarry Smith 
303c838673bSBarry Smith    Level: beginner
304c838673bSBarry Smith 
305c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
306c838673bSBarry Smith 
307c838673bSBarry Smith M*/
308c838673bSBarry Smith 
309c838673bSBarry Smith /*MC
31046a9e3ceSBarry Smith      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
31146a9e3ceSBarry Smith         See the manual page for SNESConvergedReason for more details
312c838673bSBarry Smith 
313c838673bSBarry Smith    Level: beginner
314c838673bSBarry Smith 
315c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
316c838673bSBarry Smith 
317c838673bSBarry Smith M*/
318c838673bSBarry Smith 
319c838673bSBarry Smith /*MC
320c838673bSBarry Smith      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
321c838673bSBarry Smith 
322c838673bSBarry Smith    Level: beginner
323c838673bSBarry Smith 
324c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
325c838673bSBarry Smith 
326c838673bSBarry Smith M*/
327c838673bSBarry Smith 
3287f7931b9SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
3293f149594SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
3303f149594SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
33163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergedReason(SNES,SNESConvergedReason*);
332ddbbdb52SLois Curfman McInnes 
33363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAFormFunction(SNES,Vec,Vec,void*);
33463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
33563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
33663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
3373a7fca6bSBarry Smith 
338b67197daSBarry Smith /* --------- Solving systems of nonlinear equations --------------- */
33963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunction(SNES,Vec,PetscErrorCode(*)(SNES,Vec,Vec,void*),void *);
34063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeFunction(SNES,Vec,Vec);
34163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *);
34270e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **);
34363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
34463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
3451096aae1SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetRhs(SNES,Vec*);
34617bae607SBarry Smith 
34717bae607SBarry Smith /* --------- Routines specifically for line search methods --------------- */
348dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet(SNES,PetscErrorCode(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*),void*);
349dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNo(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
350dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
351dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchCubic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
352dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchQuadratic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
353e56c5435SBarry Smith 
3543c632250SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPostCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,Vec,void*,PetscTruth*,PetscTruth*),void*);
3559c3ca13aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPreCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,void*,PetscTruth*),void*);
3569320bcb5SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetParams(SNES,PetscReal,PetscReal);
3579320bcb5SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchGetParams(SNES,PetscReal*,PetscReal*);
35894298653SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetMonitor(SNES,PetscTruth);
35940191667SLois Curfman McInnes 
360fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESTestLocalMin(SNES);
361da9b6338SBarry Smith 
362eef9c623SLois Curfman McInnes /* Should this routine be private? */
36363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);
364ddbbdb52SLois Curfman McInnes 
3656c699258SBarry Smith EXTERN PetscErrorCode PETSCKSP_DLLEXPORT SNESSetDM(SNES,DM);
3666c699258SBarry Smith EXTERN PetscErrorCode PETSCKSP_DLLEXPORT SNESGetDM(SNES,DM*);
3676c699258SBarry Smith 
368e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
369ce3d82beSBarry Smith #endif
370