annotate extra/ode/rk8fixed.m @ 0:6b33357c7561 octave-forge

Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children a0d3391e59e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
1 function [tout,xout] = rk8fixed(F,tspan,x0,Nsteps,ode_fcn_format,trace,count)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
2
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
3 % Copyright (C) 2000 Marc Compere
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
4 % This file is intended for use with Octave.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
5 % rk8fixed.m is free software; you can redistribute it and/or modify it
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
6 % under the terms of the GNU General Public License as published by
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
7 % the Free Software Foundation; either version 2, or (at your option)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
8 % any later version.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
9 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
10 % rk8fixed.m is distributed in the hope that it will be useful, but
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
11 % WITHOUT ANY WARRANTY; without even the implied warranty of
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
12 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
13 % General Public License for more details at www.gnu.org/copyleft/gpl.html.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
14 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
15 % --------------------------------------------------------------------
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
16 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
17 % rk8fixed (v1.07) is an 8th order Runge-Kutta numerical integration routine.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
18 % It requires 13 function evaluations per step. This is not the most
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
19 % efficient 8th order implementation. It was just the easiest to put
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
20 % together as a variant from ode78.m.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
21 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
22 % Usage:
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
23 % [tout, xout] = rk8fixed(F, tspan, x0, Nsteps, ode_fcn_format, trace, count)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
24 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
25 % INPUT:
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
26 % F - String containing name of user-supplied problem derivatives.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
27 % Call: xprime = fun(t,x) where F = 'fun'.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
28 % t - Time or independent variable (scalar).
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
29 % x - Solution column-vector.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
30 % xprime - Returned derivative COLUMN-vector; xprime(i) = dx(i)/dt.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
31 % tspan - [ tstart, tfinal ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
32 % x0 - Initial value COLUMN-vector.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
33 % Nsteps - number of steps used to span [ tstart, tfinal ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
34 % ode_fcn_format - this specifies if the user-defined ode function is in
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
35 % the form: xprime = fun(t,x) (ode_fcn_format=0, default)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
36 % or: xprime = fun(x,t) (ode_fcn_format=1)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
37 % Matlab's solvers comply with ode_fcn_format=0 while
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
38 % Octave's lsode() and sdirk4() solvers comply with ode_fcn_format=1.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
39 % trace - If nonzero, each step is printed. (optional, default: trace = 0).
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
40 % count - if nonzero, variable 'rhs_counter' is initalized, made global
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
41 % and counts the number of state-dot function evaluations
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
42 % 'rhs_counter' is incremented in here, not in the state-dot file
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
43 % simply make 'rhs_counter' global in the file that calls rk4fixed
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
44 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
45 % OUTPUT:
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
46 % tout - Returned integration time points (row-vector).
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
47 % xout - Returned solution, one solution column-vector per tout-value.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
48 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
49 % The result can be displayed by: plot(tout, xout).
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
50 %
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
51 % Marc Compere
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
52 % compere@mail.utexas.edu
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
53 % created : 06 October 1999
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
54 % modified: 15 May 2000
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
55
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
56 if nargin < 7, count = 0; end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
57 if nargin < 6, trace = 0; end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
58 if nargin < 5, Nsteps = 50/(tspan(2)-tspan(1)); end % <-- 50 is a guess for a default,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
59 % try verifying the solution with ode78
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
60 if nargin < 4, ode_fcn_format = 0; end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
61
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
62 if count==1,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
63 global rhs_counter
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
64 if ~exist('rhs_counter'),rhs_counter=0;,end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
65 end % if count
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
66
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
67 alpha_ = [ 2./27. 1/9 1/6 5/12 .5 5/6 1/6 2/3 1/3 1 0 1 ]';
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
68 beta_ = [ [ 2/27 0 0 0 0 0 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
69 [ 1/36 1/12 0 0 0 0 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
70 [ 1/24 0 1/8 0 0 0 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
71 [ 5/12 0 -25/16 25/16 0 0 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
72 [ .05 0 0 .25 .2 0 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
73 [ -25/108 0 0 125/108 -65/27 125/54 0 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
74 [ 31/300 0 0 0 61/225 -2/9 13/900 0 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
75 [ 2 0 0 -53/6 704/45 -107/9 67/90 3 0 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
76 [ -91/108 0 0 23/108 -976/135 311/54 -19/60 17/6 -1/12 0 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
77 [2383/4100 0 0 -341/164 4496/1025 -301/82 2133/4100 45/82 45/164 18/41 0 0 0]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
78 [ 3/205 0 0 0 0 -6/41 -3/205 -3/41 3/41 6/41 0 0 0 ]
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
79 [-1777/4100 0 0 -341/164 4496/1025 -289/82 2193/4100 ...
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
80 51/82 33/164 12/41 0 1 0]...
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
81 ]';
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
82 chi_ = [ 0 0 0 0 0 34/105 9/35 9/35 9/280 9/280 0 41/840 41/840]';
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
83
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
84 % Initialization
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
85 t = tspan(1);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
86 h = (tspan(2)-tspan(1))/Nsteps;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
87 xout(1,:) = x0';
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
88 tout(1) = t;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
89 x = x0(:);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
90 f = x*zeros(1,13);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
91
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
92 for i=1:Nsteps,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
93
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
94 % Compute the slopes
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
95 if (ode_fcn_format==0),
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
96 f(:,1) = feval(F,t,x);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
97 for j = 1:12
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
98 f(:,j+1) = feval(F, t+alpha_(j)*h, x+h*f*beta_(:,j));
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
99 end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
100 else,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
101 f(:,1) = feval(F,x,t);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
102 for j = 1:12
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
103 f(:,j+1) = feval(F, x+h*f*beta_(:,j), t+alpha_(j)*h);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
104 end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
105 end % if (ode_fcn_format==0)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
106
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
107 % increment rhs_counter
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
108 if count==1,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
109 rhs_counter = rhs_counter + 13;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
110 end % if
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
111
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
112 t = t + h;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
113 x = x + h*f*chi_;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
114 tout = [tout; t];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
115 xout = [xout; x.'];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
116
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
117 if trace,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
118 home, t, h, x
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
119 end
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
120
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
121 end