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*/ 29e5a9bf91SBarry Smith #define SNESType const char* 30eef9c623SLois Curfman McInnes #define SNESLS "ls" 31eef9c623SLois Curfman McInnes #define SNESTR "tr" 32eef9c623SLois Curfman McInnes #define SNESTEST "test" 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); 43a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSet(SNES,PetscErrorCode(*)(SNES,PetscInt,PetscReal,void*),void *,PetscErrorCode (*)(void*)); 44a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorCancel(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*); 1112999313aSBarry 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 144e5a9bf91SBarry Smith /*E 145e5a9bf91SBarry Smith MatSNESMFType - algorithm used to compute the h used in computing matrix-vector products via differencing of the function 146e5a9bf91SBarry Smith 147e5a9bf91SBarry Smith Level: beginner 148e5a9bf91SBarry Smith 149e5a9bf91SBarry Smith .seealso: MatSNESMFSetType(), MatSNESMFRegister() 150e5a9bf91SBarry Smith E*/ 151e5a9bf91SBarry Smith #define MatSNESMFType const char* 152efb30889SBarry Smith #define MATSNESMF_DS "ds" 153435da068SBarry Smith #define MATSNESMF_WP "wp" 154e5a9bf91SBarry Smith 1552e90c967SHong Zhang EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFSetType(Mat,MatSNESMFType); 15663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegister(const char[],const char[],const char[],PetscErrorCode (*)(MatSNESMFCtx)); 15730de9b25SBarry Smith 15830de9b25SBarry Smith /*MC 15930de9b25SBarry Smith MatSNESMFRegisterDynamic - Adds a method to the MatSNESMF registry. 16030de9b25SBarry Smith 16130de9b25SBarry Smith Synopsis: 162d360dc6fSBarry Smith PetscErrorCode MatSNESMFRegisterDynamic(char *name_solver,char *path,char *name_create,PetscErrorCode (*routine_create)(MatSNESMF)) 16330de9b25SBarry Smith 16430de9b25SBarry Smith Not Collective 16530de9b25SBarry Smith 16630de9b25SBarry Smith Input Parameters: 16730de9b25SBarry Smith + name_solver - name of a new user-defined compute-h module 16830de9b25SBarry Smith . path - path (either absolute or relative) the library containing this solver 16930de9b25SBarry Smith . name_create - name of routine to create method context 17030de9b25SBarry Smith - routine_create - routine to create method context 17130de9b25SBarry Smith 17230de9b25SBarry Smith Level: developer 17330de9b25SBarry Smith 17430de9b25SBarry Smith Notes: 175985db425SBarry Smith MatSNESMFRegisterDynamic() may be called multiple times to add several user-defined solvers. 17630de9b25SBarry Smith 17730de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (routine_create) 17830de9b25SBarry Smith is ignored. 17930de9b25SBarry Smith 18030de9b25SBarry Smith Sample usage: 18130de9b25SBarry Smith .vb 182985db425SBarry Smith MatSNESMFRegisterDynamic("my_h",/home/username/my_lib/lib/libO/solaris/mylib.a, 18330de9b25SBarry Smith "MyHCreate",MyHCreate); 18430de9b25SBarry Smith .ve 18530de9b25SBarry Smith 18630de9b25SBarry Smith Then, your solver can be chosen with the procedural interface via 18730de9b25SBarry Smith $ MatSNESMFSetType(mfctx,"my_h") 18830de9b25SBarry Smith or at runtime via the option 18930de9b25SBarry Smith $ -snes_mf_type my_h 19030de9b25SBarry Smith 19130de9b25SBarry Smith .keywords: MatSNESMF, register 19230de9b25SBarry Smith 19330de9b25SBarry Smith .seealso: MatSNESMFRegisterAll(), MatSNESMFRegisterDestroy() 19430de9b25SBarry Smith M*/ 195aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 196f1af5d2fSBarry Smith #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,0) 1979a6cb015SBarry Smith #else 198f1af5d2fSBarry Smith #define MatSNESMFRegisterDynamic(a,b,c,d) MatSNESMFRegister(a,b,c,d) 1999a6cb015SBarry Smith #endif 20030de9b25SBarry Smith 20163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegisterAll(const char[]); 20263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFRegisterDestroy(void); 20363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFDefaultSetUmin(Mat,PetscReal); 20463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatSNESMFWPSetComputeNormU(Mat,PetscTruth); 2058f6e3e37SBarry Smith 20663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT MatDAADSetSNES(Mat,SNES); 2073a7fca6bSBarry Smith 20863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetType(SNES,SNESType*); 209a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefault(SNES,PetscInt,PetscReal,void *); 210a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorRatio(SNES,PetscInt,PetscReal,void *); 211d86576fbSMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSetRatio(SNES,PetscViewerASCIIMonitor); 212a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolution(SNES,PetscInt,PetscReal,void *); 213a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorResidual(SNES,PetscInt,PetscReal,void *); 214a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorSolutionUpdate(SNES,PetscInt,PetscReal,void *); 215a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorDefaultShort(SNES,PetscInt,PetscReal,void *); 21663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTolerances(SNES,PetscReal,PetscReal,PetscReal,PetscInt,PetscInt); 21763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetTolerances(SNES,PetscReal*,PetscReal*,PetscReal*,PetscInt*,PetscInt*); 21863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetTrustRegionTolerance(SNES,PetscReal); 21963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetIterationNumber(SNES,PetscInt*); 220*71f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetFunctionNorm(SNES,PetscReal*); 22163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberUnsuccessfulSteps(SNES,PetscInt*); 22263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaximumUnsuccessfulSteps(SNES,PetscInt); 22363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaximumUnsuccessfulSteps(SNES,PetscInt*); 2243d4c4710SBarry Smith 2253d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetLinearSolveFailures(SNES,PetscInt*); 2263d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetMaxLinearSolveFailures(SNES,PetscInt); 2273d4c4710SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetMaxLinearSolveFailures(SNES,PetscInt*); 2283d4c4710SBarry Smith 22963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetNumberLinearIterations(SNES,PetscInt*); 230*71f87433Sdalcinl 231*71f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_SetUseEW(SNES,PetscTruth); 232*71f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_GetUseEW(SNES,PetscTruth*); 23363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_SetParametersEW(SNES,PetscInt,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 234*71f87433Sdalcinl EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNES_KSP_GetParametersEW(SNES,PetscInt*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 235eafb4bcbSBarry Smith 2363369ce9aSBarry Smith /* 2373369ce9aSBarry Smith Reuse the default KSP monitor routines for SNES 2383369ce9aSBarry Smith */ 239a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG*); 240a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLG(SNES,PetscInt,PetscReal,void*); 241a6570f20SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESMonitorLGDestroy(PetscDrawLG); 242eafb4bcbSBarry Smith 24363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetApplicationContext(SNES,void *); 24463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetApplicationContext(SNES,void **); 245184914b5SBarry Smith 246435da068SBarry Smith /*E 247435da068SBarry Smith SNESConvergedReason - reason a SNES method was said to 248435da068SBarry Smith have converged or diverged 249435da068SBarry Smith 250435da068SBarry Smith Level: beginner 251435da068SBarry Smith 252435da068SBarry Smith Notes: this must match finclude/petscsnes.h 253435da068SBarry Smith 2545968eb51SBarry Smith Developer note: The string versions of these are in 2555968eb51SBarry Smith src/snes/interface/snes.c called convergedreasons. 2565968eb51SBarry Smith If these enums are changed you much change those. 2575968eb51SBarry Smith 258435da068SBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), KSPConvergedReason, SNESSetConvergenceTest() 259435da068SBarry Smith E*/ 260184914b5SBarry Smith typedef enum {/* converged */ 261184914b5SBarry Smith SNES_CONVERGED_FNORM_ABS = 2, /* F < F_minabs */ 262184914b5SBarry Smith SNES_CONVERGED_FNORM_RELATIVE = 3, /* F < F_mintol*F_initial */ 263184914b5SBarry Smith SNES_CONVERGED_PNORM_RELATIVE = 4, /* step size small */ 264184914b5SBarry Smith SNES_CONVERGED_TR_DELTA = 7, 265184914b5SBarry Smith /* diverged */ 266d5e45103SBarry Smith SNES_DIVERGED_FUNCTION_DOMAIN = -1, 267184914b5SBarry Smith SNES_DIVERGED_FUNCTION_COUNT = -2, 2683d4c4710SBarry Smith SNES_DIVERGED_LINEAR_SOLVE = -3, 269184914b5SBarry Smith SNES_DIVERGED_FNORM_NAN = -4, 270184914b5SBarry Smith SNES_DIVERGED_MAX_IT = -5, 271184914b5SBarry Smith SNES_DIVERGED_LS_FAILURE = -6, 27258c775ebSBarry Smith SNES_DIVERGED_LOCAL_MIN = -8, /* || J^T b || is small, implies converged to local minimum of F() */ 273184914b5SBarry Smith SNES_CONVERGED_ITERATING = 0} SNESConvergedReason; 2749dcbbd2bSBarry Smith extern const char **SNESConvergedReasons; 275184914b5SBarry Smith 276c838673bSBarry Smith /*MC 277c838673bSBarry Smith SNES_CONVERGED_FNORM_ABS - 2-norm(F) <= abstol 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_CONVERGED_FNORM_RELATIVE - 2-norm(F) <= rtol*2-norm(F(x_0)) where x_0 is the initial guess 287c838673bSBarry Smith 288c838673bSBarry Smith Level: beginner 289c838673bSBarry Smith 290c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 291c838673bSBarry Smith 292c838673bSBarry Smith M*/ 293c838673bSBarry Smith 294c838673bSBarry Smith /*MC 295c838673bSBarry Smith SNES_CONVERGED_PNORM_RELATIVE - The 2-norm of the last step <= xtol * 2-norm(x) where x is the current 296c838673bSBarry Smith solution and xtol is the 4th argument to SNESSetTolerances() 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 305c838673bSBarry Smith SNES_DIVERGED_FUNCTION_COUNT - The user provided function has been called more times then the final 306c838673bSBarry Smith argument to SNESSetTolerances() 307c838673bSBarry Smith 308c838673bSBarry Smith Level: beginner 309c838673bSBarry Smith 310c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 311c838673bSBarry Smith 312c838673bSBarry Smith M*/ 313c838673bSBarry Smith 314c838673bSBarry Smith /*MC 315c838673bSBarry Smith SNES_DIVERGED_FNORM_NAN - the 2-norm of the current function evaluation is not-a-number (NaN), this 316c838673bSBarry Smith is usually caused by a division of 0 by 0. 317c838673bSBarry Smith 318c838673bSBarry Smith Level: beginner 319c838673bSBarry Smith 320c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 321c838673bSBarry Smith 322c838673bSBarry Smith M*/ 323c838673bSBarry Smith 324c838673bSBarry Smith /*MC 325c838673bSBarry Smith SNES_DIVERGED_MAX_IT - SNESSolve() has reached the maximum number of iterations requested 326c838673bSBarry Smith 327c838673bSBarry Smith Level: beginner 328c838673bSBarry Smith 329c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 330c838673bSBarry Smith 331c838673bSBarry Smith M*/ 332c838673bSBarry Smith 333c838673bSBarry Smith /*MC 334c838673bSBarry Smith SNES_DIVERGED_LS_FAILURE - The line search has failed. This only occurs for a SNESType of SNESLS 335c838673bSBarry Smith 336c838673bSBarry Smith Level: beginner 337c838673bSBarry Smith 338c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 339c838673bSBarry Smith 340c838673bSBarry Smith M*/ 341c838673bSBarry Smith 342c838673bSBarry Smith /*MC 343c838673bSBarry Smith SNES_DIVERGED_LOCAL_MIN - the algorithm seems to have stagnated at a local minimum that is not zero 344c838673bSBarry Smith 345c838673bSBarry Smith Level: beginner 346c838673bSBarry Smith 347c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 348c838673bSBarry Smith 349c838673bSBarry Smith M*/ 350c838673bSBarry Smith 351c838673bSBarry Smith /*MC 352c838673bSBarry Smith SNES_CONERGED_ITERATING - this only occurs if SNESGetConvergedReason() is called during the SNESSolve() 353c838673bSBarry Smith 354c838673bSBarry Smith Level: beginner 355c838673bSBarry Smith 356c838673bSBarry Smith .seealso: SNESSolve(), SNESGetConvergedReason(), SNESConvergedReason, SNESSetTolerances() 357c838673bSBarry Smith 358c838673bSBarry Smith M*/ 359c838673bSBarry Smith 36006ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetConvergenceTest(SNES,PetscErrorCode (*)(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void*); 36106ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESConverged_LS(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 36206ee9f85SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESConverged_TR(SNES,PetscInt,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*); 36363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetConvergedReason(SNES,SNESConvergedReason*); 364ddbbdb52SLois Curfman McInnes 36563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAFormFunction(SNES,Vec,Vec,void*); 36663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdic(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 36763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobianWithAdifor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 36863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDAComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 3693a7fca6bSBarry Smith 370b67197daSBarry Smith /* --------- Solving systems of nonlinear equations --------------- */ 37163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetFunction(SNES,Vec,PetscErrorCode(*)(SNES,Vec,Vec,void*),void *); 37263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeFunction(SNES,Vec,Vec); 37363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetJacobian(SNES,Mat,Mat,PetscErrorCode(*)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *); 37470e92668SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetJacobian(SNES,Mat*,Mat*,PetscErrorCode(**)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **); 37563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 37663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESDefaultComputeJacobianColor(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 37763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetRhs(SNES,Vec); 3781096aae1SMatthew Knepley EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESGetRhs(SNES,Vec*); 37917bae607SBarry Smith 38017bae607SBarry Smith /* --------- Routines specifically for line search methods --------------- */ 38117bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSet(SNES,PetscErrorCode(*)(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*),void*); 38217bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNo(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 38317bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchNoNorms(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 38417bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchCubic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 38517bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchQuadratic(SNES,void*,Vec,Vec,Vec,Vec,Vec,PetscReal,PetscReal*,PetscReal*,PetscTruth*); 386e56c5435SBarry Smith 3873c632250SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPostCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,Vec,void*,PetscTruth*,PetscTruth*),void*); 3889c3ca13aSBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetPreCheck(SNES,PetscErrorCode(*)(SNES,Vec,Vec,void*,PetscTruth*),void*); 38917bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchSetParams(SNES,PetscReal,PetscReal,PetscReal); 39017bae607SBarry Smith EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESLineSearchGetParams(SNES,PetscReal*,PetscReal*,PetscReal*); 39140191667SLois Curfman McInnes 392fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESTestLocalMin(SNES); 393fa039afaSSatish Balay EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESSetSolution(SNES,Vec); 394da9b6338SBarry Smith 395eef9c623SLois Curfman McInnes /* Should this routine be private? */ 39663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCSNES_DLLEXPORT SNESComputeJacobian(SNES,Vec,Mat*,Mat*,MatStructure*); 397ddbbdb52SLois Curfman McInnes 398e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 399ce3d82beSBarry Smith #endif 400