Mercurial > octave
diff scripts/ode/ode23s.m @ 28332:cf7edf5577c3 stable
doc: Improve ODE solver documentation (bug #57309)
* doc/interpreter/diffeq.txi: Mention ode23s, link solver at top of the page,
mention reference at SIAM Journal on Scientific Computing.
* scripts/help/__unimplemented__.m: Better reference for odepkg.
* scripts/ode/ode23s.m: Move incomplete reference to ODE chapter. Ensure line
length, minor spell fixes.
author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
---|---|
date | Tue, 19 May 2020 17:40:08 +0900 |
parents | f6f87fff82f9 |
children | 5a07c798eb08 28d2511f2af2 |
line wrap: on
line diff
--- a/scripts/ode/ode23s.m Mon May 18 16:12:23 2020 -0400 +++ b/scripts/ode/ode23s.m Tue May 19 17:40:08 2020 +0900 @@ -31,22 +31,21 @@ ## @deftypefnx {} {@var{solution} =} ode23s (@dots{}) ## ## Solve a set of stiff Ordinary Differential Equations (stiff ODEs) with a -## Rosenbrock method of order (2,3). For the definition of this method see -## "The MATLAB ode suite", L.F. Shampine, mass.W. Reichelt, pp.6-7 +## Rosenbrock method of order (2,3). ## ## @var{fun} is a function handle, inline function, or string containing the -## name of the function that defines the ODE: @code{M y' = f(t,y)}. The function -## must accept two inputs where the first is time @var{t} and the second is a -## column vector of unknowns @var{y}. @var{M} is a costant mass matrix, -## non-singular and possibly sparse. Set the field @var{Mass} in @var{odeopts} -## using @var{odeset} to specify a mass matrix. +## name of the function that defines the ODE: @code{M y' = f(t,y)}. The +## function must accept two inputs where the first is time @var{t} and the +## second is a column vector of unknowns @var{y}. @var{M} is a constant mass +## matrix, non-singular and possibly sparse. Set the field @var{Mass} in +## @var{odeopts} using @var{odeset} to specify a mass matrix. ## ## @var{trange} specifies the time interval over which the ODE will be -## evaluated. Typically, it is a two-element vector specifying the initial and -## final times (@code{[tinit, tfinal]}). If there are more than two elements -## then the solution will also be evaluated at these intermediate time -## instances using an interpolation procedure of the same order as the one of -## the solver. +## evaluated. Typically, it is a two-element vector specifying the initial +## and final times (@code{[tinit, tfinal]}). If there are more than two +## elements then the solution will also be evaluated at these intermediate +## time instances using an interpolation procedure of the same order as the +## one of the solver. ## ## By default, @code{ode23s} uses an adaptive timestep with the ## @code{integrate_adaptive} algorithm. The tolerance for the timestep @@ -58,9 +57,9 @@ ## the solution for the corresponding initial value in @var{init}. ## ## The optional fourth argument @var{ode_opt} specifies non-default options to -## the ODE solver. It is a structure generated by @code{odeset}. @code{ode23s} -## will ignore the following options: "BDF", "InitialSlope", "MassSingular", -## "MStateDependence", "MvPattern", "MaxOrder", "NonNegative". +## the ODE solver. It is a structure generated by @code{odeset}. +## @code{ode23s} will ignore the following options: "BDF", "InitialSlope", +## "MassSingular", "MStateDependence", "MvPattern", "MaxOrder", "NonNegative". ## ## The function typically returns two outputs. Variable @var{t} is a ## column vector and contains the times where the solution was found. The