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*/ 29eef9c623SLois Curfman McInnes #define SNESLS "ls" 30eef9c623SLois Curfman McInnes #define SNESTR "tr" 31eef9c623SLois Curfman McInnes #define SNESTEST "test" 3219dca363SMatthew Knepley #define SNESType const char* 33b1f5cb9dSBarry Smith 34deeb6e72SMatthew Knepley /* Logging support */ 3563dd3a1aSKris Buschelman extern PetscCookie PETSCSNES_DLLEXPORT SNES_COOKIE; 3663dd3a1aSKris Buschelman extern PetscCookie PETSCSNES_DLLEXPORT MATSNESMFCTX_COOKIE; 37deeb6e72SMatthew Knepley 3863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESInitializePackage(const char[]); 39deeb6e72SMatthew Knepley 4063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESCreate(MPI_Comm,SNES*); 4163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDestroy(SNES); 4219dca363SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetType(SNES,SNESType); 4363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMonitor(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void*)); 4463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESClearMonitor(SNES); 4563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceHistory(SNES,PetscReal[],PetscInt[],PetscInt,PetscTruth); 4663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergenceHistory(SNES,PetscReal*[],PetscInt *[],PetscInt *); 4770e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUp(SNES); 48f69a0ea3SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSolve(SNES,Vec,Vec); 4984cb2905SBarry Smith 5063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAddOptionsChecker(PetscErrorCode (*)(SNES)); 514d8f6ca9SMatthew Knepley 5263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetUpdate(SNES, PetscErrorCode (*)(SNES, PetscInt)); 5363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultUpdate(SNES, PetscInt); 544d8f6ca9SMatthew Knepley 55b0a32e0cSBarry Smith extern PetscFList SNESList; 5663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterDestroy(void); 5763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegisterAll(const char[]); 5884cb2905SBarry Smith 5963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRegister(const char[],const char[],const char[],PetscErrorCode (*)(SNES)); 6030de9b25SBarry Smith 6130de9b25SBarry Smith /*MC 6230de9b25SBarry Smith SNESRegisterDynamic - Adds a method to the nonlinear solver package. 6330de9b25SBarry Smith 6430de9b25SBarry Smith Synopsis: 65d360dc6fSBarry Smith PetscErrorCode SNESRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(SNES)) 6630de9b25SBarry Smith 6730de9b25SBarry Smith Not collective 6830de9b25SBarry Smith 6930de9b25SBarry Smith Input Parameters: 7030de9b25SBarry Smith + name_solver - name of a new user-defined solver 7130de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 7230de9b25SBarry Smith . name_create - name of routine to create method context 7330de9b25SBarry Smith - routine_create - routine to create method context 7430de9b25SBarry Smith 7530de9b25SBarry Smith Notes: 7630de9b25SBarry Smith SNESRegisterDynamic() may be called multiple times to add several user-defined solvers. 7730de9b25SBarry Smith 7830de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 7930de9b25SBarry Smith is ignored. 8030de9b25SBarry Smith 81ab901514SBarry Smith Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 8230de9b25SBarry Smith and others of the form ${any_environmental_variable} occuring in pathname will be 8330de9b25SBarry Smith replaced with appropriate values. 8430de9b25SBarry Smith 8530de9b25SBarry Smith Sample usage: 8630de9b25SBarry Smith .vb 8730de9b25SBarry Smith SNESRegisterDynamic("my_solver",/home/username/my_lib/lib/libg/solaris/mylib.a, 8830de9b25SBarry Smith "MySolverCreate",MySolverCreate); 8930de9b25SBarry Smith .ve 9030de9b25SBarry Smith 9130de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 9230de9b25SBarry Smith $ SNESSetType(snes,"my_solver") 9330de9b25SBarry Smith or at runtime via the option 9430de9b25SBarry Smith $ -snes_type my_solver 9530de9b25SBarry Smith 9630de9b25SBarry Smith Level: advanced 9730de9b25SBarry Smith 9830de9b25SBarry Smith Note: If your function is not being put into a shared library then use SNESRegister() instead 9930de9b25SBarry Smith 10030de9b25SBarry Smith .keywords: SNES, nonlinear, register 10130de9b25SBarry Smith 10230de9b25SBarry Smith .seealso: SNESRegisterAll(), SNESRegisterDestroy() 10330de9b25SBarry Smith M*/ 104aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 105f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,0) 106b2002411SLois Curfman McInnes #else 107f1af5d2fSBarry Smith #define SNESRegisterDynamic(a,b,c,d) SNESRegister(a,b,c,d) 108b2002411SLois Curfman McInnes #endif 109b2002411SLois Curfman McInnes 11063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetKSP(SNES,KSP*); 111*2999313aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetKSP(SNES,KSP); 11263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolution(SNES,Vec*); 11363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetSolutionUpdate(SNES,Vec*); 11470e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunction(SNES,Vec*,PetscErrorCode(**)(SNES,Vec,Vec,void*),void**); 11563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESView(SNES,PetscViewer); 1167bc3d0afSSatish Balay 11763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetOptionsPrefix(SNES,const char[]); 11863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESAppendOptionsPrefix(SNES,const char[]); 11919dca363SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetOptionsPrefix(SNES,const char*[]); 12063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFromOptions(SNES); 12140191667SLois Curfman McInnes 12263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatCreateSNESMF(SNES,Vec,Mat*); 12363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatCreateMF(Vec,Mat*); 12463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetBase(Mat,Vec); 12563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 12663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetFunction(Mat,Vec,PetscErrorCode(*)(SNES,Vec,Vec,void*),void*); 12763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetFunctioni(Mat,PetscErrorCode (*)(PetscInt,Vec,PetscScalar*,void*)); 12863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetFunctioniBase(Mat,PetscErrorCode (*)(Vec,void*)); 12963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFAddNullSpace(Mat,MatNullSpace); 13063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetHHistory(Mat,PetscScalar[],PetscInt); 13163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFResetHHistory(Mat); 13263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetFunctionError(Mat,PetscReal); 13363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetPeriod(Mat,PetscInt); 13463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFGetH(Mat,PetscScalar *); 13563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFKSPMonitor(KSP,PetscInt,PetscReal,void *); 13663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetFromOptions(Mat); 13763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFCheckPositivity(Vec,Vec,PetscScalar*,void*); 13863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetCheckh(Mat,PetscErrorCode (*)(Vec,Vec,PetscScalar*,void*),void*); 1395f323ec5SSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFDSSetUmin(Mat,PetscReal); 1405f323ec5SSatish Balay 1415b7f0c42SBarry Smith 1425a655dc6SBarry Smith typedef struct _p_MatSNESMFCtx* MatSNESMFCtx; 143435da068SBarry Smith 144efb30889SBarry Smith #define MATSNESMF_DS "ds" 145435da068SBarry Smith #define MATSNESMF_WP "wp" 14649773a63SBarry Smith #define MatSNESMFType char* 14763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetType(Mat,const MatSNESMFType); 14863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatSNESMFCtx)); 14930de9b25SBarry Smith 15030de9b25SBarry Smith /*MC 15130de9b25SBarry Smith MatSNESMFRegisterDynamic - Adds a method to the MatSNESMF registry. 15230de9b25SBarry Smith 15330de9b25SBarry Smith Synopsis: 154d360dc6fSBarry Smith PetscErrorCode MatSNESMFRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatSNESMF)) 15530de9b25SBarry Smith 15630de9b25SBarry Smith Not Collective 15730de9b25SBarry Smith 15830de9b25SBarry Smith Input Parameters: 15930de9b25SBarry Smith + name_solver - name of a new user-defined compute-h module 16030de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 16130de9b25SBarry Smith . name_create - name of routine to create method context 16230de9b25SBarry Smith - routine_create - routine to create method context 16330de9b25SBarry Smith 16430de9b25SBarry Smith Level: developer 16530de9b25SBarry Smith 16630de9b25SBarry Smith Notes: 16730de9b25SBarry Smith MatSNESMFRegisterDynamic) may be called multiple times to add several user-defined solvers. 16830de9b25SBarry Smith 16930de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 17030de9b25SBarry Smith is ignored. 17130de9b25SBarry Smith 17230de9b25SBarry Smith Sample usage: 17330de9b25SBarry Smith .vb 17430de9b25SBarry Smith MatSNESMFRegisterDynamic"my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 17530de9b25SBarry Smith "MyHCreate",MyHCreate); 17630de9b25SBarry Smith .ve 17730de9b25SBarry Smith 17830de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 17930de9b25SBarry Smith $ MatSNESMFSetType(mfctx,"my_h") 18030de9b25SBarry Smith or at runtime via the option 18130de9b25SBarry Smith $ -snes_mf_type my_h 18230de9b25SBarry Smith 18330de9b25SBarry Smith .keywords: MatSNESMF, register 18430de9b25SBarry Smith 18530de9b25SBarry Smith .seealso: MatSNESMFRegisterAll(), MatSNESMFRegisterDestroy() 18630de9b25SBarry Smith M*/ 187aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 188f1af5d2fSBarry Smith #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 1899a6cb015SBarry Smith #else 190f1af5d2fSBarry Smith #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 1919a6cb015SBarry Smith #endif 19230de9b25SBarry Smith 19363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegisterAll(const char[]); 19463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegisterDestroy(void); 19563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFDefaultSetUmin(Mat,PetscReal); 19663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 1978f6e3e37SBarry Smith 19863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatDAADSetSNES(Mat,SNES); 1993a7fca6bSBarry Smith 20063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetType(SNES,SNESType*); 20163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultMonitor(SNES,PetscInt,PetscReal,void *); 20263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESRatioMonitor(SNES,PetscInt,PetscReal,void *); 203eabae89aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetRatioMonitor(SNES,PetscViewer); 20463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESVecViewMonitor(SNES,PetscInt,PetscReal,void *); 20563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESVecViewResidualMonitor(SNES,PetscInt,PetscReal,void *); 20663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESVecViewUpdateMonitor(SNES,PetscInt,PetscReal,void *); 20763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultSMonitor(SNES,PetscInt,PetscReal,void *); 20863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 20963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 21063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTrustRegionTolerance(SNES,PetscReal); 21163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetIterationNumber(SNES,PetscInt*); 21263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunctionNorm(SNES,PetscScalar*); 21363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberUnsuccessfulSteps(SNES,PetscInt*); 21463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaximumUnsuccessfulSteps(SNES,PetscInt); 21563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaximumUnsuccessfulSteps(SNES,PetscInt*); 2163d4c4710SBarry Smith 2173d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveFailures(SNES,PetscInt*); 2183d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxLinearSolveFailures(SNES,PetscInt); 2193d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 2203d4c4710SBarry Smith 22163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberLinearIterations(SNES,PetscInt*); 22263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_SetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 22363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_SetConvergenceTestEW(SNES); 224eafb4bcbSBarry Smith 2253369ce9aSBarry Smith /* 2263369ce9aSBarry Smith Reuse the default KSP monitor routines for SNES 2273369ce9aSBarry Smith */ 22863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 22963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLGMonitor(SNES,PetscInt,PetscReal,void*); 23063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLGMonitorDestroy(PetscDrawLG); 231eafb4bcbSBarry Smith 23263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetApplicationContext(SNES,void *); 23363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetApplicationContext(SNES,void **); 234184914b5SBarry Smith 235435da068SBarry Smith /*E 236435da068SBarry Smith SNESConvergedReason - reason a SNES method was said to 237435da068SBarry Smith have converged or diverged 238435da068SBarry Smith 239435da068SBarry Smith Level: beginner 240435da068SBarry Smith 241435da068SBarry Smith Notes: this must match finclude/petscsnes.h 242435da068SBarry Smith 2435968eb51SBarry Smith Developer note: The string versions of these are in 2445968eb51SBarry Smith src/snes/interface/snes.c called convergedreasons. 2455968eb51SBarry Smith If these enums are changed you much change those. 2465968eb51SBarry Smith 247435da068SBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 248435da068SBarry Smith E*/ 249184914b5SBarry Smith typedef enum {/* converged */ 250184914b5SBarry Smith SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 251184914b5SBarry Smith SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 252184914b5SBarry Smith SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 253184914b5SBarry Smith SNES_CONVERGED_TR_DELTA = 7, 254184914b5SBarry Smith /* diverged */ 255d5e45103SBarry Smith SNES_DIVERGED_FUNCTION_DOMAIN = -1, 256184914b5SBarry Smith SNES_DIVERGED_FUNCTION_COUNT = -2, 2573d4c4710SBarry Smith SNES_DIVERGED_LINEAR_SOLVE = -3, 258184914b5SBarry Smith SNES_DIVERGED_FNORM_NAN = -4, 259184914b5SBarry Smith SNES_DIVERGED_MAX_IT = -5, 260184914b5SBarry Smith SNES_DIVERGED_LS_FAILURE = -6, 26158c775ebSBarry Smith SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 262184914b5SBarry Smith SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 2639dcbbd2bSBarry Smith extern const char **SNESConvergedReasons; 264184914b5SBarry Smith 265c838673bSBarry Smith /*MC 266c838673bSBarry Smith SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 267c838673bSBarry Smith 268c838673bSBarry Smith Level: beginner 269c838673bSBarry Smith 270c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 271c838673bSBarry Smith 272c838673bSBarry Smith M*/ 273c838673bSBarry Smith 274c838673bSBarry Smith /*MC 275c838673bSBarry Smith SNES_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 276c838673bSBarry Smith 277c838673bSBarry Smith Level: beginner 278c838673bSBarry Smith 279c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 280c838673bSBarry Smith 281c838673bSBarry Smith M*/ 282c838673bSBarry Smith 283c838673bSBarry Smith /*MC 284c838673bSBarry Smith SNES_CONVERGED_PNORM_RELATIVE - The 2-norm of the last step <= xtol * 2-norm(x) where x is the current 285c838673bSBarry Smith solution and xtol is the 4th argument to SNESSetTolerances() 286c838673bSBarry Smith 287c838673bSBarry Smith Level: beginner 288c838673bSBarry Smith 289c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 290c838673bSBarry Smith 291c838673bSBarry Smith M*/ 292c838673bSBarry Smith 293c838673bSBarry Smith /*MC 294c838673bSBarry Smith SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 295c838673bSBarry Smith argument to SNESSetTolerances() 296c838673bSBarry Smith 297c838673bSBarry Smith Level: beginner 298c838673bSBarry Smith 299c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 300c838673bSBarry Smith 301c838673bSBarry Smith M*/ 302c838673bSBarry Smith 303c838673bSBarry Smith /*MC 304c838673bSBarry Smith SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 305c838673bSBarry Smith is usually caused by a division of 0 by 0. 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 314c838673bSBarry Smith SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 315c838673bSBarry Smith 316c838673bSBarry Smith Level: beginner 317c838673bSBarry Smith 318c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 319c838673bSBarry Smith 320c838673bSBarry Smith M*/ 321c838673bSBarry Smith 322c838673bSBarry Smith /*MC 323c838673bSBarry Smith SNES_DIVERGED_LS_FAILURE - The line search has failed. This only occurs for a SNESType of SNESLS 324c838673bSBarry Smith 325c838673bSBarry Smith Level: beginner 326c838673bSBarry Smith 327c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 328c838673bSBarry Smith 329c838673bSBarry Smith M*/ 330c838673bSBarry Smith 331c838673bSBarry Smith /*MC 332c838673bSBarry Smith SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero 333c838673bSBarry Smith 334c838673bSBarry Smith Level: beginner 335c838673bSBarry Smith 336c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 337c838673bSBarry Smith 338c838673bSBarry Smith M*/ 339c838673bSBarry Smith 340c838673bSBarry Smith /*MC 341c838673bSBarry Smith SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 342c838673bSBarry Smith 343c838673bSBarry Smith Level: beginner 344c838673bSBarry Smith 345c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 346c838673bSBarry Smith 347c838673bSBarry Smith M*/ 348c838673bSBarry Smith 34906ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 35006ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESConverged_LS(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 35106ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESConverged_TR(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 35263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergedReason(SNES,SNESConvergedReason*); 353ddbbdb52SLois Curfman McInnes 35463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAFormFunction(SNES,Vec,Vec,void*); 35563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 35663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 35763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 3583a7fca6bSBarry Smith 359b67197daSBarry Smith /* --------- Solving systems of nonlinear equations --------------- */ 36063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunction(SNES,Vec,PetscErrorCode(*)(SNES,Vec,Vec,void*),void *); 36163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeFunction(SNES,Vec,Vec); 36263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 36370e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **); 36463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 36563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 36663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetRhs(SNES,Vec); 3671096aae1SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetRhs(SNES,Vec*); 36817bae607SBarry Smith 36917bae607SBarry Smith /* --------- Routines specifically for line search methods --------------- */ 37017bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet(SNES,PetscErrorCode(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*),void*); 37117bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNo(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 37217bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 37317bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchCubic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 37417bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchQuadratic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 375e56c5435SBarry Smith 3763c632250SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPostCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,Vec,void*,PetscTruth*,PetscTruth*),void*); 3779c3ca13aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPreCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,void*,PetscTruth*),void*); 37817bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetParams(SNES,PetscReal,PetscReal,PetscReal); 37917bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchGetParams(SNES,PetscReal*,PetscReal*,PetscReal*); 38040191667SLois Curfman McInnes 381fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESTestLocalMin(SNES); 382fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetSolution(SNES,Vec); 383da9b6338SBarry Smith 384eef9c623SLois Curfman McInnes /* Should this routine be private? */ 38563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 386ddbbdb52SLois Curfman McInnes 387e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 388ce3d82beSBarry Smith #endif 389