xref: /petsc/include/petscsnes.h (revision 2b4ed282327ab5af47d470b894e39b4a6dd1cbe5)
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"
35b79b07cfSJed Brown #define SNESKSPONLY "ksponly"
36*2b4ed282SShri Abhyankar #define SNESVI      "vi"
37b1f5cb9dSBarry Smith 
38deeb6e72SMatthew Knepley /* Logging support */
390700a824SBarry Smith extern PetscClassId PETSCSNES_DLLEXPORT SNES_CLASSID;
40deeb6e72SMatthew Knepley 
4163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESInitializePackage(const char[]);
42deeb6e72SMatthew Knepley 
4363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESCreate(MPI_Comm,SNES*);
4463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDestroy(SNES);
45a313700dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetType(SNES,const SNESType);
46a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void*));
47a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorCancel(SNES);
4863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscTruth);
4963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *);
5070e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUp(SNES);
51f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSolve(SNES,Vec,Vec);
52e113a28aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetErrorIfNotConverged(SNES,PetscTruth);
53e113a28aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetErrorIfNotConverged(SNES,PetscTruth *);
54e113a28aSBarry Smith 
5584cb2905SBarry Smith 
5663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAddOptionsChecker(PetscErrorCode (*)(SNES));
574d8f6ca9SMatthew Knepley 
5863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt));
5963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultUpdate(SNES, PetscInt);
604d8f6ca9SMatthew Knepley 
61b0a32e0cSBarry Smith extern PetscFList SNESList;
6263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterDestroy(void);
6363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterAll(const char[]);
6484cb2905SBarry Smith 
6563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES));
6630de9b25SBarry Smith 
6730de9b25SBarry Smith /*MC
6830de9b25SBarry Smith    SNESRegisterDynamic - Adds a method to the nonlinear solver package.
6930de9b25SBarry Smith 
7030de9b25SBarry Smith    Synopsis:
711890ba74SBarry Smith    PetscErrorCode SNESRegisterDynamic(const char *name_solver,const char *path,const char *name_create,PetscErrorCode (*routine_create)(SNES))
7230de9b25SBarry Smith 
7330de9b25SBarry Smith    Not collective
7430de9b25SBarry Smith 
7530de9b25SBarry Smith    Input Parameters:
7630de9b25SBarry Smith +  name_solver - name of a new user-defined solver
7730de9b25SBarry Smith .  path - path (either absolute or relative) the library containing this solver
7830de9b25SBarry Smith .  name_create - name of routine to create method context
7930de9b25SBarry Smith -  routine_create - routine to create method context
8030de9b25SBarry Smith 
8130de9b25SBarry Smith    Notes:
8230de9b25SBarry Smith    SNESRegisterDynamic() may be called multiple times to add several user-defined solvers.
8330de9b25SBarry Smith 
8430de9b25SBarry Smith    If dynamic libraries are used, then the fourth input argument (routine_create)
8530de9b25SBarry Smith    is ignored.
8630de9b25SBarry Smith 
87ab901514SBarry Smith    Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
8830de9b25SBarry Smith    and others of the form ${any_environmental_variable} occuring in pathname will be
8930de9b25SBarry Smith    replaced with appropriate values.
9030de9b25SBarry Smith 
9130de9b25SBarry Smith    Sample usage:
9230de9b25SBarry Smith .vb
9330de9b25SBarry Smith    SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a,
9430de9b25SBarry Smith                 "MySolverCreate",MySolverCreate);
9530de9b25SBarry Smith .ve
9630de9b25SBarry Smith 
9730de9b25SBarry Smith    Then, your solver can be chosen with the procedural interface via
9830de9b25SBarry Smith $     SNESSetType(snes,"my_solver")
9930de9b25SBarry Smith    or at runtime via the option
10030de9b25SBarry Smith $     -snes_type my_solver
10130de9b25SBarry Smith 
10230de9b25SBarry Smith    Level: advanced
10330de9b25SBarry Smith 
10430de9b25SBarry Smith     Note: If your function is not being put into a shared library then use SNESRegister() instead
10530de9b25SBarry Smith 
10630de9b25SBarry Smith .keywords: SNES, nonlinear, register
10730de9b25SBarry Smith 
10830de9b25SBarry Smith .seealso: SNESRegisterAll(), SNESRegisterDestroy()
10930de9b25SBarry Smith M*/
110aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
111f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0)
112b2002411SLois Curfman McInnes #else
113f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d)
114b2002411SLois Curfman McInnes #endif
115b2002411SLois Curfman McInnes 
11663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetKSP(SNES,KSP*);
1172999313aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetKSP(SNES,KSP);
11863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolution(SNES,Vec*);
11963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolutionUpdate(SNES,Vec*);
12070e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunction(SNES,Vec*,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**);
12163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESView(SNES,PetscViewer);
1227bc3d0afSSatish Balay 
12363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetOptionsPrefix(SNES,const char[]);
12463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAppendOptionsPrefix(SNES,const char[]);
12519dca363SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetOptionsPrefix(SNES,const char*[]);
12663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFromOptions(SNES);
12740191667SLois Curfman McInnes 
128fef1beadSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatCreateSNESMF(SNES,Mat*);
129e884886fSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatMFFDComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
1308f6e3e37SBarry Smith 
13163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatDAADSetSNES(Mat,SNES);
1323a7fca6bSBarry Smith 
133a313700dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetType(SNES,const SNESType*);
134a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefault(SNES,PetscInt,PetscReal,void *);
135b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorRange(SNES,PetscInt,PetscReal,void *);
136a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorRatio(SNES,PetscInt,PetscReal,void *);
137d86576fbSMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSetRatio(SNES,PetscViewerASCIIMonitor);
138a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolution(SNES,PetscInt,PetscReal,void *);
139a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorResidual(SNES,PetscInt,PetscReal,void *);
140a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *);
141a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *);
14263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt);
14363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*);
14463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTrustRegionTolerance(SNES,PetscReal);
14571f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunctionNorm(SNES,PetscReal*);
146b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetIterationNumber(SNES,PetscInt*);
1473d4c4710SBarry Smith 
148b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNonlinearStepFailures(SNES,PetscInt*);
149b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxNonlinearStepFailures(SNES,PetscInt);
150b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxNonlinearStepFailures(SNES,PetscInt*);
1512541af92SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberFunctionEvals(SNES,PetscInt*);
152b850b91aSLisandro Dalcin 
153a8054027SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetLagPreconditioner(SNES,PetscInt);
154a8054027SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLagPreconditioner(SNES,PetscInt*);
155e35cf81dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetLagJacobian(SNES,PetscInt);
156e35cf81dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLagJacobian(SNES,PetscInt*);
157a8054027SBarry Smith 
158b850b91aSLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveIterations(SNES,PetscInt*);
1593d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveFailures(SNES,PetscInt*);
1603d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxLinearSolveFailures(SNES,PetscInt);
1613d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxLinearSolveFailures(SNES,PetscInt*);
1623d4c4710SBarry Smith 
163fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPSetUseEW(SNES,PetscTruth);
164fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPGetUseEW(SNES,PetscTruth*);
165fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPSetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
166fa9f3622SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESKSPGetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
167eafb4bcbSBarry Smith 
168a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
169a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLG(SNES,PetscInt,PetscReal,void*);
170a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGDestroy(PetscDrawLG);
171b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRangeCreate(const char[],const char[],int,int,int,int,PetscDrawLG*);
172b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRange(SNES,PetscInt,PetscReal,void*);
173b271bb04SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGRangeDestroy(PetscDrawLG);
174eafb4bcbSBarry Smith 
17563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetApplicationContext(SNES,void *);
17663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetApplicationContext(SNES,void **);
177184914b5SBarry Smith 
1781d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESPythonSetType(SNES,const char[]);
1791d6018f0SLisandro Dalcin 
1804936397dSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunctionDomainError(SNES);
181435da068SBarry Smith /*E
182435da068SBarry Smith     SNESConvergedReason - reason a SNES method was said to
183435da068SBarry Smith          have converged or diverged
184435da068SBarry Smith 
185435da068SBarry Smith    Level: beginner
186435da068SBarry Smith 
187f203c74bSBarry Smith    The two most common reasons for divergence are
188f203c74bSBarry Smith $   1) an incorrectly coded or computed Jacobian or
189f203c74bSBarry Smith $   2) failure or lack of convergence in the linear system (in this case we recommend
190f203c74bSBarry Smith $      testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
191f203c74bSBarry Smith 
192f203c74bSBarry Smith    Diverged Reasons:
193f203c74bSBarry Smith .    SNES_DIVERGED_LOCAL_MIN - this can only occur when using the line-search variant of SNES.
194f203c74bSBarry Smith        The line search wants to minimize Q(alpha) = 1/2 || F(x + alpha s) ||^2_2  this occurs
195f203c74bSBarry 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
196f203c74bSBarry Smith        you get Q'(alpha) = -F(x)^T F'(x)^(-1)^T F'(x+alpha s)F(x+alpha s); when alpha = 0
197f203c74bSBarry Smith        Q'(0) = - ||F(x)||^2_2 which is always NEGATIVE if F'(x) is invertible. This means the Newton
198f203c74bSBarry Smith        direction is a descent direction and the line search should succeed if alpha is small enough.
199f203c74bSBarry Smith 
200f203c74bSBarry Smith        If F'(x) is NOT invertible AND F'(x)^T F(x) = 0 then Q'(0) = 0 and the Newton direction
201f203c74bSBarry Smith        is NOT a descent direction so the line search will fail. All one can do at this point
202f203c74bSBarry Smith        is change the initial guess and try again.
203f203c74bSBarry Smith 
204f203c74bSBarry Smith        An alternative explanation: Newton's method can be regarded as replacing the function with
205f203c74bSBarry Smith        its linear approximation and minimizing the 2-norm of that. That is F(x+s) approx F(x) + F'(x)s
206f203c74bSBarry Smith        so we minimize || F(x) + F'(x) s ||^2_2; do this using Least Squares. If F'(x) is invertible then
207f203c74bSBarry 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
208f203c74bSBarry Smith        exists a nontrival (that is F'(x)s != 0) solution to the equation and this direction is
209f203c74bSBarry 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)
210f203c74bSBarry 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
211f203c74bSBarry Smith        and F'(x)^T F'(x) has no negative eigenvalues Q'(0) < 0 so s is a descent direction and the line
212f203c74bSBarry Smith        search should succeed for small enough alpha.
213f203c74bSBarry Smith 
214f203c74bSBarry Smith        Note that this RARELY happens in practice. Far more likely the linear system is not being solved
215f203c74bSBarry Smith        (well enough?) or the Jacobian is wrong.
216f203c74bSBarry Smith 
2174d0a8057SBarry Smith    SNES_DIVERGED_MAX_IT means that the solver reached the maximum number of iterations without satisfying any
2184d0a8057SBarry Smith    convergence criteria. SNES_CONVERGED_ITS means that SNESSkipConverged() was chosen as the convergence test;
2194d0a8057SBarry Smith    thus the usual convergence criteria have not been checked and may or may not be satisfied.
220f203c74bSBarry Smith 
2214d0a8057SBarry Smith    Developer Notes: this must match finclude/petscsnes.h
2224d0a8057SBarry Smith 
2234d0a8057SBarry Smith        The string versions of these are in SNESConvergedReason, if you change any value here you must
2244d0a8057SBarry Smith      also adjust that array.
2255968eb51SBarry Smith 
22646a9e3ceSBarry Smith    Each reason has its own manual page.
22746a9e3ceSBarry Smith 
228435da068SBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest()
229435da068SBarry Smith E*/
230184914b5SBarry Smith typedef enum {/* converged */
23101b82886SBarry Smith               SNES_CONVERGED_FNORM_ABS         =  2, /* ||F|| < atol */
23201b82886SBarry Smith               SNES_CONVERGED_FNORM_RELATIVE    =  3, /* ||F|| < rtol*||F_initial|| */
23346a9e3ceSBarry Smith               SNES_CONVERGED_PNORM_RELATIVE    =  4, /* Newton computed step size small; || delta x || < stol */
2343f149594SLisandro Dalcin               SNES_CONVERGED_ITS               =  5, /* maximum iterations reached */
235184914b5SBarry Smith               SNES_CONVERGED_TR_DELTA            =  7,
236184914b5SBarry Smith               /* diverged */
23746a9e3ceSBarry Smith               SNES_DIVERGED_FUNCTION_DOMAIN     = -1, /* the new x location passed the function is not in the domain of F */
238184914b5SBarry Smith               SNES_DIVERGED_FUNCTION_COUNT      = -2,
23946a9e3ceSBarry Smith               SNES_DIVERGED_LINEAR_SOLVE        = -3, /* the linear solve failed */
240184914b5SBarry Smith               SNES_DIVERGED_FNORM_NAN           = -4,
241184914b5SBarry Smith               SNES_DIVERGED_MAX_IT              = -5,
242647a2e1fSBarry Smith               SNES_DIVERGED_LINE_SEARCH         = -6, /* the line search failed */
24358c775ebSBarry Smith               SNES_DIVERGED_LOCAL_MIN           = -8, /* || J^T b || is small, implies converged to local minimum of F() */
244184914b5SBarry Smith               SNES_CONVERGED_ITERATING          =  0} SNESConvergedReason;
2459dcbbd2bSBarry Smith extern const char **SNESConvergedReasons;
246184914b5SBarry Smith 
247c838673bSBarry Smith /*MC
248c838673bSBarry Smith      SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol
249c838673bSBarry Smith 
250c838673bSBarry Smith    Level: beginner
251c838673bSBarry Smith 
252c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
253c838673bSBarry Smith 
254c838673bSBarry Smith M*/
255c838673bSBarry Smith 
256c838673bSBarry Smith /*MC
257c838673bSBarry Smith      SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess
258c838673bSBarry Smith 
259c838673bSBarry Smith    Level: beginner
260c838673bSBarry Smith 
261c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
262c838673bSBarry Smith 
263c838673bSBarry Smith M*/
264c838673bSBarry Smith 
265c838673bSBarry Smith /*MC
26646a9e3ceSBarry Smith      SNES_CONVERGED_PNORM_RELATIVE - The 2-norm of the last step <= stol * 2-norm(x) where x is the current
26746a9e3ceSBarry Smith           solution and stol is the 4th argument to SNESSetTolerances()
268c838673bSBarry Smith 
269c838673bSBarry Smith    Level: beginner
270c838673bSBarry Smith 
271c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
272c838673bSBarry Smith 
273c838673bSBarry Smith M*/
274c838673bSBarry Smith 
275c838673bSBarry Smith /*MC
276c838673bSBarry Smith      SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final
277c838673bSBarry Smith          argument to SNESSetTolerances()
278c838673bSBarry Smith 
279c838673bSBarry Smith    Level: beginner
280c838673bSBarry Smith 
281c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
282c838673bSBarry Smith 
283c838673bSBarry Smith M*/
284c838673bSBarry Smith 
285c838673bSBarry Smith /*MC
286c838673bSBarry Smith      SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this
287c838673bSBarry Smith       is usually caused by a division of 0 by 0.
288c838673bSBarry Smith 
289c838673bSBarry Smith    Level: beginner
290c838673bSBarry Smith 
291c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
292c838673bSBarry Smith 
293c838673bSBarry Smith M*/
294c838673bSBarry Smith 
295c838673bSBarry Smith /*MC
296c838673bSBarry Smith      SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested
297c838673bSBarry Smith 
298c838673bSBarry Smith    Level: beginner
299c838673bSBarry Smith 
300c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
301c838673bSBarry Smith 
302c838673bSBarry Smith M*/
303c838673bSBarry Smith 
304c838673bSBarry Smith /*MC
305647a2e1fSBarry Smith      SNES_DIVERGED_LINE_SEARCH - The line search has failed. This only occurs for a SNESType of SNESLS
306c838673bSBarry Smith 
307c838673bSBarry Smith    Level: beginner
308c838673bSBarry Smith 
309c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
310c838673bSBarry Smith 
311c838673bSBarry Smith M*/
312c838673bSBarry Smith 
313c838673bSBarry Smith /*MC
31446a9e3ceSBarry Smith      SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero.
31546a9e3ceSBarry Smith         See the manual page for SNESConvergedReason for more details
316c838673bSBarry Smith 
317c838673bSBarry Smith    Level: beginner
318c838673bSBarry Smith 
319c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
320c838673bSBarry Smith 
321c838673bSBarry Smith M*/
322c838673bSBarry Smith 
323c838673bSBarry Smith /*MC
324c838673bSBarry Smith      SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve()
325c838673bSBarry Smith 
326c838673bSBarry Smith    Level: beginner
327c838673bSBarry Smith 
328c838673bSBarry Smith .seealso:  SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances()
329c838673bSBarry Smith 
330c838673bSBarry Smith M*/
331c838673bSBarry Smith 
3327f7931b9SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*,PetscErrorCode (*)(void*));
3333f149594SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
3343f149594SLisandro Dalcin EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSkipConverged(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*);
33563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergedReason(SNES,SNESConvergedReason*);
336ddbbdb52SLois Curfman McInnes 
33763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAFormFunction(SNES,Vec,Vec,void*);
33863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
33963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
34063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
3413a7fca6bSBarry Smith 
342b67197daSBarry Smith /* --------- Solving systems of nonlinear equations --------------- */
34363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunction(SNES,Vec,PetscErrorCode(*)(SNES,Vec,Vec,void*),void *);
34463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeFunction(SNES,Vec,Vec);
34563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *);
34670e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **);
34763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
34863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
3491096aae1SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetRhs(SNES,Vec*);
35017bae607SBarry Smith 
35117bae607SBarry Smith /* --------- Routines specifically for line search methods --------------- */
352dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet(SNES,PetscErrorCode(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*),void*);
353dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNo(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
354dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
355dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchCubic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
356dc357ad2SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchQuadratic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal,PetscReal*,PetscReal*,PetscTruth*);
357e56c5435SBarry Smith 
3583c632250SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPostCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,Vec,void*,PetscTruth*,PetscTruth*),void*);
3599c3ca13aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPreCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,void*,PetscTruth*),void*);
360b3dd4ab5SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetParams(SNES,PetscReal,PetscReal,PetscReal);
361b3dd4ab5SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchGetParams(SNES,PetscReal*,PetscReal*,PetscReal*);
36294298653SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetMonitor(SNES,PetscTruth);
36340191667SLois Curfman McInnes 
364fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESTestLocalMin(SNES);
365da9b6338SBarry Smith 
366eef9c623SLois Curfman McInnes /* Should this routine be private? */
36763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*);
368ddbbdb52SLois Curfman McInnes 
369cfb32e20SJed Brown EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetDM(SNES,DM);
370cfb32e20SJed Brown EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetDM(SNES,DM*);
3716c699258SBarry Smith 
372e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
373ce3d82beSBarry Smith #endif
374