diff --git a/src/problems/basic_problems.jl b/src/problems/basic_problems.jl index 443ec8018..d5315fcbe 100644 --- a/src/problems/basic_problems.jl +++ b/src/problems/basic_problems.jl @@ -18,7 +18,7 @@ Au = b For matrix-free versions, the specification of the problem is given by an operator `A(u,p,t)` which computes `A*u`, or in-place as `A(du,u,p,t)`. These -are specified via the `AbstractSciMLOperator` interface. For more details, see +are specified via the `AbstractDiffEqOperator` interface. For more details, see the [SciMLBase Documentation](https://docs.sciml.ai/SciMLBase/stable/). Note that matrix-free versions of LinearProblem definitions are not compatible @@ -32,13 +32,13 @@ Optionally, an initial guess ``uâ‚€`` can be supplied which is used for iterativ methods. ```julia -LinearProblem{isinplace}(A,x,p=NullParameters();u0=nothing,kwargs...) -LinearProblem(f::AbstractDiffEqOperator,u0,p=NullParameters();u0=nothing,kwargs...) +LinearProblem(A,b,p=NullParameters();u0=nothing,kwargs...) +LinearProblem{isinplace}(f::AbstractDiffEqOperator,b,p=NullParameters();u0=nothing,kwargs...) ``` `isinplace` optionally sets whether the function is in-place or not, i.e. whether the solvers are allowed to mutate. By default this is true for `AbstractMatrix`, -and for `AbstractSciMLOperator`s it matches the choice of the operator definition. +and for `AbstractDiffEqOperator`s it matches the choice of the operator definition. Parameters are optional, and if not given, then a `NullParameters()` singleton will be used, which will throw nice errors if you try to index non-existent @@ -48,7 +48,7 @@ parameters. Any extra keyword arguments are passed on to the solvers. * `A`: The representation of the linear operator. * `b`: The right-hand side of the linear system. -* `p`: The parameters for the problem. Defaults to `NullParameters`. Currently unused. +* `p`: The parameters for the problem. Defaults to `NullParameters`. * `u0`: The initial condition used by iterative solvers. * `kwargs`: The keyword arguments passed on to the solvers. """