Skip to content

Commit

Permalink
add warning to BLS interface
Browse files Browse the repository at this point in the history
  • Loading branch information
rveltz committed Jun 2, 2024
1 parent 9d84d0e commit f39fbf5
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/src/interfaceLS.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ n

where $\xi_u,\xi_p\in\mathbb C$ and $dR,\xi_u\in\mathbb C^N$.

!!! warning "PALC"
To work with PALC, the struct `bls` must have the field `solver` available even if this one is `nothing`

| Required methods | | Brief description |
|:------------------------------ |:---------------------- |:------------------------------------------------------------------------------------- |
| `bls(J, dR, dzu, dzp, R, n, ξu::Number, ξp::Number; shift = nothing, kwargs...)` | | Compute the solution `dX, dl` of the linear problem (BLS) where `J` is the jacobian and `dR, dzu` are vectors (not necessarily subtypes of `AbstractVector`). `shift = nothing` is used in place of saying `shift=0`. Returns `(dX, dl, success::Bool, itnumber)` where `itnumber` is the number of iterations for solving the problem.|

0 comments on commit f39fbf5

Please sign in to comment.