Nonlinear solvers - SNES: Examples

The Scalable Nonlinear Equations Solvers (SNES) component provides an easy-to-use interface to Newton-based methods for solving systems of nonlinear equations. SNES users can set various algorithmic options at runtime via the options database (e.g., specifying a trust region method via -snes_type tr ). SNES internally employs KSP for the solution of its linear systems. SNES users can also set KSP options directly in application codes by first extracting the KSP context from the SNES context via SNESGetKSP() and then directly calling various KSP (and KSP and PC) routines (e.g., PCSetType() ).

Beginner - Basic usage
SNES SNESSetFunction SNES_CONVERGED_FNORM_RELATIVE
SNESConvergedReason SNESSetJacobian SNES_CONVERGED_PNORM_RELATIVE
SNESCreate SNESSolve SNES_DIVERGED_FNORM_NAN
SNESDestroy SNESType SNES_DIVERGED_FUNCTION_COUNT
SNESGetKSP SNESView SNES_DIVERGED_LOCAL_MIN
SNESLS SNES_CONERGED_ITERATING SNES_DIVERGED_LS_FAILURE
SNESSetFromOptions SNES_CONVERGED_FNORM_ABS SNES_DIVERGED_MAX_IT
Intermediate - Setting options for algorithms and data structures
SNESConverged_LS SNESGetMaxNonlinearStepFailures SNESMonitorSolution
SNESConverged_TR SNESGetNonlinearStepFailures SNESMonitorSolutionUpdate
SNESDefaultComputeJacobian SNESGetRhs SNESSetApplicationContext
SNESDefaultComputeJacobianColor SNESGetSolution SNESSetConvergenceHistory
SNESDefaultConverged SNESGetTolerances SNESSetMaxLinearSolveFailures
SNESDefaultUpdate SNESGetType SNESSetMaxNonlinearStepFailures
SNESGetApplicationContext SNESLineSearchGetParams SNESSetRhs
SNESGetConvergedReason SNESLineSearchSetParams SNESSetSolution
SNESGetConvergenceHistory SNESMonitorCancel SNESSetTolerances
SNESGetFunctionNorm SNESMonitorDefault SNESSetTrustRegionTolerance
SNESGetIterationNumber SNESMonitorRatio SNESSetType
SNESGetLinearSolveFailures SNESMonitorResidual SNESSetUpdate
SNESGetLinearSolveIterations SNESMonitorSet SNESTEST
SNESGetMaxLinearSolveFailures SNESMonitorSetRatio SNESTR
Advanced - Setting more advanced options and customization
SNESAppendOptionsPrefix SNESKSPSetUseEW SNESRegister
SNESDefaultMatrixFreeSetParameters2 SNESLineSearchCubic SNESRegisterAll
SNESGetFunction SNESLineSearchNo SNESRegisterDestroy
SNESGetJacobian SNESLineSearchNoNorms SNESRegisterDynamic
SNESGetOptionsPrefix SNESLineSearchQuadratic SNESSetConvergenceTest
SNESGetSolutionUpdate SNESLineSearchSet SNESSetOptionsPrefix
SNESKSPGetParametersEW SNESLineSearchSetPostCheck SNESSetUp
SNESKSPGetUseEW SNESLineSearchSetPreCheck SNESSkipConverged
SNESKSPSetParametersEW SNESMatrixFreeCreate2
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
SNESAddOptionsChecker SNESComputeJacobian SNESSetKSP
SNESComputeFunction SNESInitializePackage
No deprecated routines

Table of Contents