From 6a7144aab08a822b76a731a106d9127701f1e4ba Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Sun, 19 Feb 2023 12:03:03 -0500 Subject: [PATCH 1/2] Add page on termination conditions --- docs/pages.jl | 1 + docs/src/basics/TerminationCondition.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/src/basics/TerminationCondition.md diff --git a/docs/pages.jl b/docs/pages.jl index 14f391d36..f1562d439 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -7,6 +7,7 @@ pages = ["index.md", "basics/NonlinearFunctions.md", "basics/solve.md", "basics/NonlinearSolution.md", + "api/TerminationCondition.md", "basics/FAQ.md"], "Solver Summaries and Recommendations" => Any["solvers/NonlinearSystemSolvers.md", "solvers/BracketingSolvers.md", diff --git a/docs/src/basics/TerminationCondition.md b/docs/src/basics/TerminationCondition.md new file mode 100644 index 000000000..cd780b997 --- /dev/null +++ b/docs/src/basics/TerminationCondition.md @@ -0,0 +1,11 @@ +# Termination Conditions + +Provides a API to specify termination conditions for [`NonLinearProblem`](@ref) and +[`SteadyStateProblem`](@ref). For details on the various termination modes, i.e., +NLSolveTerminationMode, see the documentation for [`NLSolveTerminationCondition`](@ref). + +## Termination Condition API + +```@docs +NLSolveTerminationCondition +``` From dc4f1a6c9ac1e8b68cf7524cd48ab6133bff37ae Mon Sep 17 00:00:00 2001 From: Christopher Rackauckas Date: Sun, 19 Feb 2023 12:04:30 -0500 Subject: [PATCH 2/2] Update docs/pages.jl --- docs/pages.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages.jl b/docs/pages.jl index f1562d439..6d9b5d0e2 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -7,7 +7,7 @@ pages = ["index.md", "basics/NonlinearFunctions.md", "basics/solve.md", "basics/NonlinearSolution.md", - "api/TerminationCondition.md", + "basics/TerminationCondition.md", "basics/FAQ.md"], "Solver Summaries and Recommendations" => Any["solvers/NonlinearSystemSolvers.md", "solvers/BracketingSolvers.md",