Skip to content

Commit

Permalink
add docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscardssmith authored Oct 22, 2024
1 parent 86eebab commit b2fa45a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/scimlfunctions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,10 @@ the usage of `f`. These include:
based on the sparsity pattern. Defaults to `nothing`, which means a color vector will be
internally computed on demand when required. The cost of this operation is highly dependent
on the sparsity pattern.
- `nlfunc`: a `NonlinearFunction`
- `nlfunc`: a `NonlinearFunction` with signature `f(u, (u_tmp, _t, p)) = u_tmp`.
where `u` and `u_tmp` are of the same type as `u`, and `_t` is of the same type of t.
This will be used as the nonlinear function inside an implicit solver by specifying `u, u_tmp` and `_t`
such that solving this function produces a solution to the implicit step of your solver.
## iip: In-Place vs Out-Of-Place
Expand Down

0 comments on commit b2fa45a

Please sign in to comment.