Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add page on termination conditions #155

Merged
merged 2 commits into from
Feb 19, 2023
Merged

Add page on termination conditions #155

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a7144a
Add page on termination conditions
avik-pal Feb 19, 2023
dc4f1a6
Update docs/pages.jl
ChrisRackauckas Feb 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ pages = ["index.md",
"basics/NonlinearFunctions.md",
"basics/solve.md",
"basics/NonlinearSolution.md",
"api/TerminationCondition.md",
ChrisRackauckas marked this conversation as resolved.
Show resolved Hide resolved
"basics/FAQ.md"],
"Solver Summaries and Recommendations" => Any["solvers/NonlinearSystemSolvers.md",
"solvers/BracketingSolvers.md",
Expand Down
11 changes: 11 additions & 0 deletions docs/src/basics/TerminationCondition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```