Skip to content

Commit b2fa45a

Browse files
author
Oscar Smith
authored
add docs.
1 parent 86eebab commit b2fa45a

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/scimlfunctions.jl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,10 @@ the usage of `f`. These include:
289289
based on the sparsity pattern. Defaults to `nothing`, which means a color vector will be
290290
internally computed on demand when required. The cost of this operation is highly dependent
291291
on the sparsity pattern.
292-
- `nlfunc`: a `NonlinearFunction`
292+
- `nlfunc`: a `NonlinearFunction` with signature `f(u, (u_tmp, _t, p)) = u_tmp`.
293+
where `u` and `u_tmp` are of the same type as `u`, and `_t` is of the same type of t.
294+
This will be used as the nonlinear function inside an implicit solver by specifying `u, u_tmp` and `_t`
295+
such that solving this function produces a solution to the implicit step of your solver.
293296
294297
## iip: In-Place vs Out-Of-Place
295298

0 commit comments

Comments
 (0)