From e9ea42798fd4a182149a32b62223aff8bf96e7c3 Mon Sep 17 00:00:00 2001 From: Christopher Rackauckas Date: Thu, 26 May 2022 23:44:24 -0400 Subject: [PATCH] Update NonlinearFunctions.md --- docs/src/basics/NonlinearFunctions.md | 31 ++------------------------- 1 file changed, 2 insertions(+), 29 deletions(-) diff --git a/docs/src/basics/NonlinearFunctions.md b/docs/src/basics/NonlinearFunctions.md index 7b57ac988..b420d891b 100644 --- a/docs/src/basics/NonlinearFunctions.md +++ b/docs/src/basics/NonlinearFunctions.md @@ -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 ```