Skip to content

Commit

Permalink
Update NonlinearFunctions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisRackauckas authored May 27, 2022
1 parent 21fe33b commit e9ea427
Showing 1 changed file with 2 additions and 29 deletions.
31 changes: 2 additions & 29 deletions docs/src/basics/NonlinearFunctions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,6 @@ of pre-computed functions to speed up the calculations. This is offered via the

## Function Type Definitions

### Function Choice Definitions

The full interface available to the solvers is as follows:

- `jac`: The Jacobian of the differential equation with respect to the state
variable `u` at a time `t` with parameters `p`.
- `tgrad`: The gradient of the differential equation with respect to `t` at state
`u` with parameters `p`.
- `paramjac`: The Jacobian of the differential equation with respect to `p` at
state `u` at time `t`.
- `analytic`: Defines an analytical solution using `u0` at time `t` with `p`
which will cause the solvers to return errors. Used for testing.
- `syms`: Allows you to name your variables for automatic names in plots and
other output.

### NonlinearFunction

```julia
function NonlinearFunction{iip,true}(f;
analytic=nothing, # (u0,p)
jac=nothing, # (J,u,p) or (u,p)
jvp=nothing,
vjp=nothing,
jac_prototype=nothing, # Type for the Jacobian
sparsity=jac_prototype,
paramjac = nothing,
syms = nothing,
observed = DEFAULT_OBSERVED_NO_TIME,
colorvec = nothing)
```@docs
SciMLBase.NonlinearFunction
```

0 comments on commit e9ea427

Please sign in to comment.