annotate scripts/ode/ode23.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2006-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
6 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
7 ## This file is part of Octave.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23407
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23407
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22707
diff changeset
12 ## (at your option) any later version.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
13 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22707
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22707
diff changeset
17 ## GNU General Public License for more details.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
18 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23407
diff changeset
21 ## <https://www.gnu.org/licenses/>.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
22
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
23 ## -*- texinfo -*-
21319
8880d93010d8 Remove further uses of CLASS field in @deftypefn macro.
Rik <rik@octave.org>
parents: 21123
diff changeset
24 ## @deftypefn {} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init})
8880d93010d8 Remove further uses of CLASS field in @deftypefn macro.
Rik <rik@octave.org>
parents: 21123
diff changeset
25 ## @deftypefnx {} {[@var{t}, @var{y}] =} ode23 (@var{fun}, @var{trange}, @var{init}, @var{ode_opt})
8880d93010d8 Remove further uses of CLASS field in @deftypefn macro.
Rik <rik@octave.org>
parents: 21123
diff changeset
26 ## @deftypefnx {} {[@var{t}, @var{y}, @var{te}, @var{ye}, @var{ie}] =} ode23 (@dots{})
8880d93010d8 Remove further uses of CLASS field in @deftypefn macro.
Rik <rik@octave.org>
parents: 21123
diff changeset
27 ## @deftypefnx {} {@var{solution} =} ode23 (@dots{})
22939
54302b670139 doc: Document nargout=0 calling mode for ode23, ode45.
Rik <rik@octave.org>
parents: 22937
diff changeset
28 ## @deftypefnx {} {} ode23 (@dots{})
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
29 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
30 ## Solve a set of non-stiff Ordinary Differential Equations (non-stiff ODEs)
21123
71408ab5071e doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents: 20928
diff changeset
31 ## with the well known explicit @nospell{Bogacki-Shampine} method of order 3.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
32 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
33 ## @var{fun} is a function handle, inline function, or string containing the
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
34 ## name of the function that defines the ODE: @code{y' = f(t,y)}. The function
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
35 ## must accept two inputs where the first is time @var{t} and the second is a
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
36 ## column vector of unknowns @var{y}.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
37 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
38 ## @var{trange} specifies the time interval over which the ODE will be
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
39 ## evaluated. Typically, it is a two-element vector specifying the initial and
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
40 ## final times (@code{[tinit, tfinal]}). If there are more than two elements
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
41 ## then the solution will also be evaluated at these intermediate time
22594
b8d525710075 cleanup ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22593
diff changeset
42 ## instances.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
43 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
44 ## By default, @code{ode23} uses an adaptive timestep with the
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
45 ## @code{integrate_adaptive} algorithm. The tolerance for the timestep
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
46 ## computation may be changed by using the options @qcode{"RelTol"} and
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
47 ## @qcode{"AbsTol"}.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
48 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
49 ## @var{init} contains the initial value for the unknowns. If it is a row
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
50 ## vector then the solution @var{y} will be a matrix in which each column is
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
51 ## the solution for the corresponding initial value in @var{init}.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
52 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
53 ## The optional fourth argument @var{ode_opt} specifies non-default options to
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
54 ## the ODE solver. It is a structure generated by @code{odeset}.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
55 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
56 ## The function typically returns two outputs. Variable @var{t} is a
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
57 ## column vector and contains the times where the solution was found. The
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
58 ## output @var{y} is a matrix in which each column refers to a different
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
59 ## unknown of the problem and each row corresponds to a time in @var{t}.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
60 ##
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
61 ## The output can also be returned as a structure @var{solution} which has a
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
62 ## field @var{x} containing a row vector of times where the solution was
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
63 ## evaluated and a field @var{y} containing the solution matrix such that each
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
64 ## column corresponds to a time in @var{x}. Use
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
65 ## @w{@code{fieldnames (@var{solution})}} to see the other fields and
21546
f7f97d7e9294 doc: Wrap m-file docstrings to 79 characters + newline (80 total).
Rik <rik@octave.org>
parents: 21443
diff changeset
66 ## additional information returned.
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
67 ##
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
68 ## If no output arguments are requested, and no @code{OutputFcn} is specified
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
69 ## in @var{ode_opt}, then the @code{OutputFcn} is set to @code{odeplot} and the
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
70 ## results of the solver are plotted immediately.
22939
54302b670139 doc: Document nargout=0 calling mode for ode23, ode45.
Rik <rik@octave.org>
parents: 22937
diff changeset
71 ##
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
72 ## If using the @qcode{"Events"} option then three additional outputs may be
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
73 ## returned. @var{te} holds the time when an Event function returned a zero.
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
74 ## @var{ye} holds the value of the solution at time @var{te}. @var{ie}
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
75 ## contains an index indicating which Event function was triggered in the case
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
76 ## of multiple Event functions.
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
77 ##
21123
71408ab5071e doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents: 20928
diff changeset
78 ## Example: Solve the @nospell{Van der Pol} equation
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
79 ##
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
80 ## @example
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
81 ## @group
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
82 ## fvdp = @@(@var{t},@var{y}) [@var{y}(2); (1 - @var{y}(1)^2) * @var{y}(2) - @var{y}(1)];
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
83 ## [@var{t},@var{y}] = ode23 (fvdp, [0, 20], [2, 0]);
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
84 ## @end group
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
85 ## @end example
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
86 ##
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
87 ## Reference: For the definition of this method see
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
88 ## @url{https://en.wikipedia.org/wiki/List_of_Runge%E2%80%93Kutta_methods}.
25026
f886561f9696 doc: improve differential eqtn docs and mention ode15i/ode15s (bug #51965).
Colin Macdonald <cbm@m.fsf.org>
parents: 24534
diff changeset
89 ## @seealso{odeset, odeget, ode45, ode15s}
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
90 ## @end deftypefn
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
91
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
92 function varargout = ode23 (fun, trange, init, varargin)
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
93
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
94 if (nargin < 3)
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
95 print_usage ();
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
96 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
97
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
98 order = 3;
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
99 solver = "ode23";
20928
2b8447888e0a strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 20908
diff changeset
100
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
101 if (nargin >= 4)
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
102 if (! isstruct (varargin{1}))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
103 ## varargin{1:len} are parameters for fun
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
104 odeopts = odeset ();
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
105 funarguments = varargin;
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
106 elseif (numel (varargin) > 1)
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
107 ## varargin{1} is an ODE options structure opt
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
108 odeopts = varargin{1};
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
109 funarguments = {varargin{2:numel (varargin)}};
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
110 else # if (isstruct (varargin{1}))
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
111 odeopts = varargin{1};
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
112 funarguments = {};
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
113 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
114 else # nargin == 3
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
115 odeopts = odeset ();
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
116 funarguments = {};
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
117 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
118
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
119 if (! isnumeric (trange) || ! isvector (trange))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
120 error ("Octave:invalid-input-arg",
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
121 "ode23: TRANGE must be a numeric vector");
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
122 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
123
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
124 if (numel (trange) < 2)
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
125 error ("Octave:invalid-input-arg",
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
126 "ode23: TRANGE must contain at least 2 elements");
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
127 elseif (trange(2) == trange(1))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
128 error ("Octave:invalid-input-arg",
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
129 "ode23: invalid time span, TRANGE(1) == TRANGE(2)");
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
130 else
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
131 direction = sign (trange(2) - trange(1));
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
132 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
133 trange = trange(:);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
134
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
135 if (! isnumeric (init) || ! isvector (init))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
136 error ("Octave:invalid-input-arg",
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
137 "ode23: INIT must be a numeric vector");
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
138 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
139 init = init(:);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
140
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
141 if (ischar (fun))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
142 try
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
143 fun = str2func (fun);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
144 catch
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
145 warning (lasterr);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
146 end_try_catch
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
147 endif
25803
23483673ba43 Use is_function_handle instead of isa (x, "function_handle").
Rik <rik@octave.org>
parents: 25143
diff changeset
148 if (! is_function_handle (fun))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
149 error ("Octave:invalid-input-arg",
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
150 "ode23: FUN must be a valid function handle");
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
151 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
152
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
153 ## Start preprocessing, have a look which options are set in odeopts,
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
154 ## check if an invalid or unused option is set.
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
155 [defaults, classes, attributes] = odedefaults (numel (init),
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
156 trange(1), trange(end));
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
157
22660
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
158 persistent ode23_ignore_options = ...
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
159 {"BDF", "InitialSlope", "Jacobian", "JPattern",
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
160 "MassSingular", "MaxOrder", "MvPattern", "Vectorized"};
22707
413a19bca7f3 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 22661
diff changeset
161
22660
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
162 defaults = rmfield (defaults, ode23_ignore_options);
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
163 classes = rmfield (classes, ode23_ignore_options);
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
164 attributes = rmfield (attributes, ode23_ignore_options);
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
165
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
166 odeopts = odemergeopts ("ode23", odeopts, defaults, classes, attributes);
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
167
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
168 odeopts.funarguments = funarguments;
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
169 odeopts.direction = direction;
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
170
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
171 if (! isempty (odeopts.NonNegative))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
172 if (isempty (odeopts.Mass))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
173 odeopts.havenonnegative = true;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
174 else
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
175 odeopts.havenonnegative = false;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
176 warning ("Octave:invalid-input-arg",
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
177 ['ode23: option "NonNegative" is ignored', ...
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
178 " when mass matrix is set\n"]);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
179 endif
20928
2b8447888e0a strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 20908
diff changeset
180 else
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
181 odeopts.havenonnegative = false;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
182 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
183
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
184 if (isempty (odeopts.OutputFcn) && nargout == 0)
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
185 odeopts.OutputFcn = @odeplot;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
186 odeopts.haveoutputfunction = true;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
187 else
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
188 odeopts.haveoutputfunction = ! isempty (odeopts.OutputFcn);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
189 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
190
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
191 if (isempty (odeopts.InitialStep))
20908
0fb9de5b7903 remove verbose warnings from ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 20902
diff changeset
192 odeopts.InitialStep = odeopts.direction * ...
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
193 starting_stepsize (order, fun, trange(1), init,
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
194 odeopts.AbsTol, odeopts.RelTol,
22935
c9344df03da5 Allow case-insensitive option argument 'on' to ode solvers (bug #49918).
Rik <rik@octave.org>
parents: 22934
diff changeset
195 strcmpi (odeopts.NormControl, "on"),
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
196 odeopts.funarguments);
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
197 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
198
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
199 if (! isempty (odeopts.Mass) && isnumeric (odeopts.Mass))
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
200 havemasshandle = false;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
201 mass = odeopts.Mass; # constant mass
25803
23483673ba43 Use is_function_handle instead of isa (x, "function_handle").
Rik <rik@octave.org>
parents: 25143
diff changeset
202 elseif (is_function_handle (odeopts.Mass))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
203 havemasshandle = true; # mass defined by a function handle
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
204 else # no mass matrix - creating a diag-matrix of ones for mass
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
205 havemasshandle = false; # mass = diag (ones (length (init), 1), 0);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
206 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
207
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
208 ## Starting the initialization of the core solver ode23
20928
2b8447888e0a strip trailing whitespace from files
John W. Eaton <jwe@octave.org>
parents: 20908
diff changeset
209
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
210 if (havemasshandle) # Handle only the dynamic mass matrix,
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
211 if (! strcmp (odeopts.MStateDependence, "none"))
22661
c00578ac8dda Resolve FIXME notes in ode code base.
Rik <rik@octave.org>
parents: 22660
diff changeset
212 ## constant mass matrices have already been handled
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
213 mass = @(t,x) odeopts.Mass (t, x, odeopts.funarguments{:});
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
214 fun = @(t,x) mass (t, x, odeopts.funarguments{:}) ...
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
215 \ fun (t, x, odeopts.funarguments{:});
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
216 else
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
217 mass = @(t) odeopts.Mass (t, odeopts.funarguments{:});
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
218 fun = @(t,x) mass (t, odeopts.funarguments{:}) ...
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
219 \ fun (t, x, odeopts.funarguments{:});
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
220 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
221 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
222
22659
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
223 if (nargout == 1)
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
224 ## Single output requires auto-selected intermediate times,
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
225 ## which is obtained by NOT specifying specific solution times.
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
226 trange = [trange(1); trange(end)];
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
227 odeopts.Refine = []; # disable Refine when single output requested
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
228 elseif (numel (trange) > 2)
04fc7e9c5f96 Disable Refine option of ode solvers for certain input/output combinations (partial fix bug #49408).
Rik <rik@octave.org>
parents: 22658
diff changeset
229 odeopts.Refine = []; # disable Refine when specific times requested
22658
56d7d423aff9 Return intermediate integration times when single output argument used in ode solver (bug #49417).
Rik <rik@octave.org>
parents: 22655
diff changeset
230 endif
56d7d423aff9 Return intermediate integration times when single output argument used in ode solver (bug #49417).
Rik <rik@octave.org>
parents: 22655
diff changeset
231
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
232 solution = integrate_adaptive (@runge_kutta_23,
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
233 order, fun, trange, init, odeopts);
22625
081a201b77c7 Clean up ode options implementation to follow Octave coding standards.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22605
diff changeset
234
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
235 ## Postprocessing, do whatever when terminating integration algorithm
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
236 if (odeopts.haveoutputfunction) # Cleanup plotter
22639
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
237 feval (odeopts.OutputFcn, [], [], "done", odeopts.funarguments{:});
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
238 endif
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
239 if (! isempty (odeopts.Events)) # Cleanup event function handling
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
240 ode_event_handler (odeopts.Events, solution.t(end),
22655
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
241 solution.x(end,:).', "done", odeopts.funarguments{:});
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
242 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
243
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
244 ## Print additional information if option Stats is set
22935
c9344df03da5 Allow case-insensitive option argument 'on' to ode solvers (bug #49918).
Rik <rik@octave.org>
parents: 22934
diff changeset
245 if (strcmpi (odeopts.Stats, "on"))
21955
0f3e875d9078 Fix statistics on solution solving for ode45, ode23 (bug #48243).
jcorno <jacopo.corno@gmail.com>
parents: 21751
diff changeset
246 nsteps = solution.cntloop; # cntloop from 2..end
0f3e875d9078 Fix statistics on solution solving for ode45, ode23 (bug #48243).
jcorno <jacopo.corno@gmail.com>
parents: 21751
diff changeset
247 nfailed = solution.cntcycles - nsteps; # cntcycl from 1..end
0f3e875d9078 Fix statistics on solution solving for ode45, ode23 (bug #48243).
jcorno <jacopo.corno@gmail.com>
parents: 21751
diff changeset
248 nfevals = 3 * solution.cntcycles + 1; # number of ode evaluations
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
249 ndecomps = 0; # number of LU decompositions
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
250 npds = 0; # number of partial derivatives
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
251 nlinsols = 0; # no. of solutions of linear systems
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
252
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
253 printf ("Number of successful steps: %d\n", nsteps);
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
254 printf ("Number of failed attempts: %d\n", nfailed);
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
255 printf ("Number of function calls: %d\n", nfevals);
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
256 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
257
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
258 if (nargout == 2)
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
259 varargout{1} = solution.t; # Time stamps are first output argument
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
260 varargout{2} = solution.x; # Results are second output argument
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
261 elseif (nargout == 1)
22655
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
262 varargout{1}.x = solution.t.'; # Time stamps are saved in field x (row vector)
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
263 varargout{1}.y = solution.x.'; # Results are saved in field y (row vector)
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
264 varargout{1}.solver = solver; # Solver name is saved in field solver
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
265 if (! isempty (odeopts.Events))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
266 varargout{1}.xe = solution.event{3}; # Time info when an event occurred
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
267 varargout{1}.ye = solution.event{4}; # Results when an event occurred
22955
3c72c72233e3 ode23.m, ode45.m: Switch output creation order of struct fields to match Matlab.
Rik <rik@octave.org>
parents: 22940
diff changeset
268 varargout{1}.ie = solution.event{2}; # Index info which event occurred
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
269 endif
22935
c9344df03da5 Allow case-insensitive option argument 'on' to ode solvers (bug #49918).
Rik <rik@octave.org>
parents: 22934
diff changeset
270 if (strcmpi (odeopts.Stats, "on"))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
271 varargout{1}.stats = struct ();
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
272 varargout{1}.stats.nsteps = nsteps;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
273 varargout{1}.stats.nfailed = nfailed;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
274 varargout{1}.stats.nfevals = nfevals;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
275 varargout{1}.stats.npds = npds;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
276 varargout{1}.stats.ndecomps = ndecomps;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
277 varargout{1}.stats.nlinsols = nlinsols;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
278 endif
22937
2b2ac017c901 Fix undefined return argument for more than 2 outputs from ode solver (bug #49890).
Rik <rik@octave.org>
parents: 22707
diff changeset
279 elseif (nargout > 2)
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
280 varargout = cell (1,5);
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
281 varargout{1} = solution.t;
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
282 varargout{2} = solution.x;
22593
dba5074bdc79 simplify options management in ode solvers
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22445
diff changeset
283 if (! isempty (odeopts.Events))
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
284 varargout{3} = solution.event{3}; # Time info when an event occurred
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
285 varargout{4} = solution.event{4}; # Results when an event occurred
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
286 varargout{5} = solution.event{2}; # Index info which event occurred
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
287 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
288 endif
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
289
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
290 endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
291
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
292
21599
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
293 %!demo
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
294 %! ## Demonstrate convergence order for ode23
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
295 %! tol = 1e-5 ./ 10.^[0:8];
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
296 %! for i = 1 : numel (tol)
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
297 %! opt = odeset ("RelTol", tol(i), "AbsTol", realmin);
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
298 %! [t, y] = ode23 (@(t, y) -y, [0, 1], 1, opt);
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
299 %! h(i) = 1 / (numel (t) - 1);
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
300 %! err(i) = norm (y .* exp (t) - 1, Inf);
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
301 %! endfor
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
302 %!
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
303 %! ## Estimate order visually
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
304 %! loglog (h, tol, "-ob",
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
305 %! h, err, "-b",
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
306 %! h, (h/h(end)) .^ 2 .* tol(end), "k--",
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
307 %! h, (h/h(end)) .^ 3 .* tol(end), "k-");
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
308 %! axis tight
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
309 %! xlabel ("h");
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
310 %! ylabel ("err(h)");
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
311 %! title ("Convergence plot for ode23");
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
312 %! legend ("imposed tolerance", "ode23 (relative) error",
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
313 %! "order 2", "order 3", "location", "northwest");
22647
cf8ec7abb4ae Clean up demo and test blocks for ode functions.
Rik <rik@octave.org>
parents: 22644
diff changeset
314 %!
cf8ec7abb4ae Clean up demo and test blocks for ode functions.
Rik <rik@octave.org>
parents: 22644
diff changeset
315 %! ## Estimate order numerically
cf8ec7abb4ae Clean up demo and test blocks for ode functions.
Rik <rik@octave.org>
parents: 22644
diff changeset
316 %! p = diff (log (err)) ./ diff (log (h))
21599
f29d68e24c5a ode23.m, ode45.m: More reformatting of demos to Octave coding standards.
Rik <rik@octave.org>
parents: 21596
diff changeset
317
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
318 ## We are using the Van der Pol equation for all tests.
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
319 ## Further tests also define a reference solution (computed at high accuracy)
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
320 %!function ydot = fpol (t, y) # The Van der Pol ODE
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
321 %! ydot = [y(2); (1 - y(1)^2) * y(2) - y(1)];
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
322 %!endfunction
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
323 %!function ref = fref () # The computed reference sol
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
324 %! ref = [0.32331666704577, -1.83297456798624];
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
325 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
326 %!function [val, trm, dir] = feve (t, y, varargin)
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
327 %! val = fpol (t, y, varargin); # We use the derivatives
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
328 %! trm = zeros (2,1); # that's why component 2
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
329 %! dir = ones (2,1); # does not seem to be exact
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
330 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
331 %!function [val, trm, dir] = fevn (t, y, varargin)
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
332 %! val = fpol (t, y, varargin); # We use the derivatives
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
333 %! trm = ones (2,1); # that's why component 2
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
334 %! dir = ones (2,1); # does not seem to be exact
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
335 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
336 %!function mas = fmas (t, y, varargin)
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
337 %! mas = [1, 0; 0, 1]; # Dummy mass matrix for tests
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
338 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
339 %!function mas = fmsa (t, y, varargin)
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
340 %! mas = sparse ([1, 0; 0, 1]); # A sparse dummy matrix
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
341 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
342 %!function out = fout (t, y, flag, varargin)
22639
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
343 %! out = false;
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
344 %! if (strcmp (flag, "init"))
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
345 %! if (! isequal (size (t), [2, 1]))
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
346 %! error ('fout: step "init"');
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
347 %! endif
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
348 %! elseif (isempty (flag))
22639
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
349 %! if (! isequal (size (t), [1, 1]))
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
350 %! error ('fout: step "calc"');
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
351 %! endif
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
352 %! elseif (strcmp (flag, "done"))
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
353 %! if (! isempty (t))
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
354 %! warning ('fout: step "done"');
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
355 %! endif
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
356 %! else
22639
7efa2d0e22c9 More Matlab-compatible implementation of OutputFcn. Clean up odeplot.m.
Rik <rik@octave.org>
parents: 22626
diff changeset
357 %! error ("fout: invalid flag <%s>", flag);
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
358 %! endif
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
359 %!endfunction
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
360 %!
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
361 %!test # two output arguments
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
362 %! [t, y] = ode23 (@fpol, [0 2], [2 0]);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
363 %! assert ([t(end), y(end,:)], [2, fref], 1e-3);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
364 %!test # anonymous function instead of real function
22644
23941beb44cd Cleanup variable names, obsolete ChangeLog info in ode23, ode45.
Rik <rik@octave.org>
parents: 22643
diff changeset
365 %! fvdp = @(t,y) [y(2); (1 - y(1)^2) * y(2) - y(1)];
23941beb44cd Cleanup variable names, obsolete ChangeLog info in ode23, ode45.
Rik <rik@octave.org>
parents: 22643
diff changeset
366 %! [t, y] = ode23 (fvdp, [0 2], [2 0]);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
367 %! assert ([t(end), y(end,:)], [2, fref], 1e-3);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
368 %!test # extra input arguments passed through
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
369 %! [t, y] = ode23 (@fpol, [0 2], [2 0], 12, 13, "KL");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
370 %! assert ([t(end), y(end,:)], [2, fref], 1e-3);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
371 %!test # empty OdePkg structure *but* extra input arguments
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
372 %! opt = odeset;
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
373 %! [t, y] = ode23 (@fpol, [0 2], [2 0], opt, 12, 13, "KL");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
374 %! assert ([t(end), y(end,:)], [2, fref], 1e-2);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
375 %!test # Solve another anonymous function below zero
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
376 %! ref = [0, 14.77810590694212];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
377 %! [t, y] = ode23 (@(t,y) y, [-2 0], 2);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
378 %! assert ([t(end), y(end,:)], ref, 1e-2);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
379 %!test # InitialStep option
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
380 %! opt = odeset ("InitialStep", 1e-8);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
381 %! [t, y] = ode23 (@fpol, [0 0.2], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
382 %! assert ([t(2)-t(1)], [1e-8], 1e-9);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
383 %!test # MaxStep option
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
384 %! opt = odeset ("MaxStep", 1e-3);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
385 %! sol = ode23 (@fpol, [0 0.2], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
386 %! assert ([sol.x(5)-sol.x(4)], [1e-3], 1e-4);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
387 %!test # Solve in backward direction starting at t=0
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
388 %! ref = [-1.205364552835178, 0.951542399860817];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
389 %! sol = ode23 (@fpol, [0 -2], [2 0]);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
390 %! assert ([sol.x(end); sol.y(:,end)], [-2; ref'], 5e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
391 %!test # Solve in backward direction starting at t=2
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
392 %! ref = [-1.205364552835178, 0.951542399860817];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
393 %! sol = ode23 (@fpol, [2 0 -2], fref);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
394 %! assert ([sol.x(end); sol.y(:,end)], [-2; ref'], 2e-2);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
395 %!test # Solve another anonymous function in backward direction
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
396 %! ref = [-1, 0.367879437558975];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
397 %! sol = ode23 (@(t,y) y, [0 -1], 1);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
398 %! assert ([sol.x(end); sol.y(:,end)], ref', 1e-2);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
399 %!test # Solve another anonymous function below zero
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
400 %! ref = [0, 14.77810590694212];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
401 %! sol = ode23 (@(t,y) y, [-2 0], 2);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
402 %! assert ([sol.x(end); sol.y(:,end)], ref', 1e-2);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
403 %!test # Solve in backward direction starting at t=0 with MaxStep option
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
404 %! ref = [-1.205364552835178, 0.951542399860817];
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
405 %! opt = odeset ("MaxStep", 1e-3);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
406 %! sol = ode23 (@fpol, [0 -2], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
407 %! assert ([abs(sol.x(8)-sol.x(7))], [1e-3], 1e-3);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
408 %! assert ([sol.x(end); sol.y(:,end)], [-2; ref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
409 %!test # AbsTol option
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
410 %! opt = odeset ("AbsTol", 1e-5);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
411 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
412 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
413 %!test # AbsTol and RelTol option
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
414 %! opt = odeset ("AbsTol", 1e-8, "RelTol", 1e-8);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
415 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
416 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
23407
e265ae9e7a6c Fix hermite cubic interpolation in ode23
Andreas Stahel <Andreas.Stahel@bfh.ch>
parents: 23220
diff changeset
417 %!test # hermite_cubic_interpolation
e265ae9e7a6c Fix hermite cubic interpolation in ode23
Andreas Stahel <Andreas.Stahel@bfh.ch>
parents: 23220
diff changeset
418 %! opt = odeset ("RelTol", 1e-8, "NormControl", "on");
e265ae9e7a6c Fix hermite cubic interpolation in ode23
Andreas Stahel <Andreas.Stahel@bfh.ch>
parents: 23220
diff changeset
419 %! [t,sol] = ode23(@(t,x)[x(2);x(1)],linspace(0,1),[1;0],opt);
e265ae9e7a6c Fix hermite cubic interpolation in ode23
Andreas Stahel <Andreas.Stahel@bfh.ch>
parents: 23220
diff changeset
420 %! assert(max(abs(sol(:,1)-cosh(t))),0,1e-6)
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
421 %!test # RelTol and NormControl option -- higher accuracy
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
422 %! opt = odeset ("RelTol", 1e-8, "NormControl", "on");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
423 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
424 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-4);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
425 %!test # Keeps initial values while integrating
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
426 %! opt = odeset ("NonNegative", 2);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
427 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
428 %! assert ([sol.x(end); sol.y(:,end)], [2; 2; 0], 1e-1);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
429 %!test # Details of OutputSel and Refine can't be tested
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
430 %! opt = odeset ("OutputFcn", @fout, "OutputSel", 1, "Refine", 5);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
431 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
432 %!test # Stats must add further elements in sol
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
433 %! opt = odeset ("Stats", "on");
22934
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
434 %! stat_str = evalc ("sol = ode23 (@fpol, [0 2], [2 0], opt);");
bb452f84a299 Fix printing of solution stats in ode23/ode45 solvers (bug #49918).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22900
diff changeset
435 %! assert (strncmp (stat_str, "Number of successful steps:", 27));
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
436 %! assert (isfield (sol, "stats"));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
437 %! assert (isfield (sol.stats, "nsteps"));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
438 %!test # Events option add further elements in sol
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
439 %! opt = odeset ("Events", @feve);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
440 %! sol = ode23 (@fpol, [0 10], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
441 %! assert (isfield (sol, "ie"));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
442 %! assert (sol.ie(1), 2);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
443 %! assert (isfield (sol, "xe"));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
444 %! assert (isfield (sol, "ye"));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
445 %!test # Events option, now stop integration
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
446 %! warning ("off", "integrate_adaptive:unexpected_termination", "local");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
447 %! opt = odeset ("Events", @fevn, "NormControl", "on");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
448 %! sol = ode23 (@fpol, [0 10], [2 0], opt);
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21546
diff changeset
449 %! assert ([sol.ie, sol.xe, sol.ye],
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21546
diff changeset
450 %! [2.0, 2.496110, -0.830550, -2.677589], .5e-1);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
451 %!test # Events option, five output arguments
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
452 %! warning ("off", "integrate_adaptive:unexpected_termination", "local");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
453 %! opt = odeset ("Events", @fevn, "NormControl", "on");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
454 %! [t, y, vxe, ye, vie] = ode23 (@fpol, [0 10], [2 0], opt);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
455 %! assert ([vie, vxe, ye], [2.0, 2.496110, -0.830550, -2.677589], 1e-1);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
456 %!test # Mass option as function
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
457 %! opt = odeset ("Mass", @fmas);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
458 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
459 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
460 %!test # Mass option as matrix
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
461 %! opt = odeset ("Mass", eye (2,2));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
462 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
463 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
464 %!test # Mass option as sparse matrix
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
465 %! opt = odeset ("Mass", sparse (eye (2,2)));
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
466 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
467 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
468 %!test # Mass option as function and sparse matrix
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
469 %! opt = odeset ("Mass", @fmsa);
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
470 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
471 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
472 %!test # Mass option as function and MStateDependence
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
473 %! opt = odeset ("Mass", @fmas, "MStateDependence", "strong");
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
474 %! sol = ode23 (@fpol, [0 2], [2 0], opt);
22654
bc61ed076549 Change orientation of output fields in struct returned from ode solvers (bug #49402).
Sebastian Schöps <sebastian@schoeps.org>
parents: 22647
diff changeset
475 %! assert ([sol.x(end); sol.y(:,end)], [2; fref'], 1e-3);
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
476
22660
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
477 ## Note: The following options have no effect on this solver
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
478 ## therefore it makes no sense to test them here:
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
479 ##
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
480 ## "BDF"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
481 ## "InitialSlope"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
482 ## "JPattern"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
483 ## "Jacobian"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
484 ## "MassSingular"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
485 ## "MaxOrder"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
486 ## "MvPattern"
7eb3f8ec1aed Remove FIXME comment about missing tests for ignored ODE options.
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22659
diff changeset
487 ## "Vectorized"
20901
afe9c529760d 2015 Code Sprint: move ode23 and runge_kutta_23 from odepkg to core
Stefan Miereis <stefan.miereis@gmx.de>
parents:
diff changeset
488
22655
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
489 %!test # Check that imaginary part of solution does not get inverted
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
490 %! sol = ode23 (@(x,y) 1, [0 1], 1i);
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
491 %! assert (imag (sol.y), ones (size (sol.y)))
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
492 %! [x, y] = ode23 (@(x,y) 1, [0 1], 1i);
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
493 %! assert (imag (y), ones (size (y)))
6b134d294d61 ode solvers: use ordinary transpose instead of Hermitian conjugate (bug #49410).
Carlo de Falco <carlo.defalco@polimi.it>
parents: 22654
diff changeset
494
21443
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
495 ## Test input validation
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
496 %!error ode23 ()
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
497 %!error ode23 (1)
acd6e203031d Alter BIST tests stop emitting warnings during runtests invocation.
Rik <rik@octave.org>
parents: 21319
diff changeset
498 %!error ode23 (1,2)
22626
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
499 %!error <TRANGE must be a numeric> ode23 (@fpol, {[0 25]}, [3 15 1])
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
500 %!error <TRANGE must be a .* vector> ode23 (@fpol, [0 25; 25 0], [3 15 1])
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
501 %!error <TRANGE must contain at least 2 elements> ode23 (@fpol, [1], [3 15 1])
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
502 %!error <invalid time span> ode23 (@fpol, [1 1], [3 15 1])
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
503 %!error <INIT must be a numeric> ode23 (@fpol, [0 25], {[3 15 1]})
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
504 %!error <INIT must be a .* vector> ode23 (@fpol, [0 25], [3 15 1; 3 15 1])
869c02fde46c Further clean-up of ode functions.
Rik <rik@octave.org>
parents: 22625
diff changeset
505 %!error <FUN must be a valid function handle> ode23 (1, [0 25], [3 15 1])