Skip to content

Commit

Permalink
Correct solve_nonlinear docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
KnutAM authored Jul 5, 2024
1 parent 5d6df99 commit cd67232
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/nlsolvers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -240,13 +240,11 @@ function get_linear_solver end

# Top-level method to overload
"""
solve_nonlinear!(problem, nlsolver, last_converged)
solve_nonlinear!(problem, nlsolver)
Solve the current time step in the nonlinear `problem`, (`r(x) = 0`),
by using the nonlinear solver `nlsolver`. `last_converged::Bool`
is just for information if the last time step converged or not.
In many cases it suffices to overload [`calculate_update!`](@ref)
for a custom nonlinear solver.
by using the nonlinear solver `nlsolver`. In many cases, it suffices
to overload [`calculate_update!`](@ref) for a custom nonlinear solver.
"""
function solve_nonlinear!(problem, nlsolver)
maxiter = get_max_iter(nlsolver)
Expand Down

0 comments on commit cd67232

Please sign in to comment.