ODEPACK solvers (daskr): adding Scilab macro example for pjac and psol
[scilab.git] / scilab / modules / differential_equations / tests / unit_tests / daskr.tst
1 // =============================================================================
2 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 // Copyright (C) Scilab Enterprises - 2013 - Paul Bignier
4 //
5 // This file must be used under the terms of the CeCILL.
6 // This source file is licensed as described in the file COPYING,
7 // which you should have received as part of this distribution.
8 // The terms are also available at
9 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10 // =============================================================================
11
12 // Run with test_run('differential_equations', 'daskr', ['no_check_error_output']);
13
14 //C-----------------------------------------------------------------------
15 //C First problem.
16 //C The initial value problem is..
17 //C   DY/DT = ((2*LOG(Y) + 8)/T - 5)*Y,  Y(1) = 1,  1 .LE. T .LE. 6
18 //C The solution is  Y(T) = EXP(-T**2 + 5*T - 4), YPRIME(1) = 3
19 //C The two root functions are..
20 //C   G1 = ((2*LOG(Y)+8)/T - 5)*Y (= DY/DT)  (with root at T = 2.5),
21 //C   G2 = LOG(Y) - 2.2491  (with roots at T = 2.47 and 2.53)
22 //C-----------------------------------------------------------------------
23 y0=1;t=2:6;t0=1;y0d=3;
24 info=list([],0,[],[],[],0,[],1,[],0,1,[],[],1);
25 atol=1.d-6;rtol=0;ng=2;
26 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,'res1',ng,'gr1',info,'psol1','pjac1');
27 if abs(nn(1)-2.47)>0.001 then pause,end
28 y0=yy(2,2);y0d=yy(3,2);t0=nn(1);t=[3,4,5,6];
29 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,'res1',ng,'gr1',info,'psol1','pjac1');
30 if abs(nn(1)-2.5)>0.001 then pause,end
31 y0=yy(2,1);y0d=yy(3,1);t0=nn(1);t=[3,4,5,6];
32 info=list([],0,[],[],[],0,[],0,[],0,0,[],[],1);
33 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,'res1',ng,'gr1',info);
34 if abs(nn(1)-2.53)>0.001 then pause,end
35
36 // Same problem, but using macro for the derivative evaluation function 'res1'
37 deff('[delta,ires]=res1(t,y,ydot)','ires=0;delta=ydot-((2*log(y)+8)/t-5)*y')
38 deff('[rts]=gr1(t,y,yd)','rts=[((2*log(y)+8)/t-5)*y;log(y)-2.2491]')
39
40 y0=1;t=2:6;t0=1;y0d=3;
41 atol=1.d-6;rtol=0;ng=2;
42 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,gr1,info);
43 if abs(nn(1)-2.47)>0.001 then pause,end
44 y0=yy(2,2);y0d=yy(3,2);t0=nn(1);t=[3,4,5,6];
45 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,gr1,info);
46 if abs(nn(1)-2.5)>0.001 then pause,end
47 y0=yy(2,1);y0d=yy(3,1);t0=nn(1);t=[3,4,5,6];
48 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,gr1,info);
49 if abs(nn(1)-2.53)>0.001 then pause,end
50
51 // Same problem, but using macros for the preconditioner evaluation and application functions 'pjac' and 'psol'
52 // pjac uses the macro res1 defined above.
53 function [r, ier] = psol(wp, iwp, b)
54     ier = 0;
55     //Compute the LU factorization of R.
56     sp = sparse(iwp, wp);
57     [h, rk] = lufact(sp);
58     //Solve the system LU*X = b
59     r = lusolve(h, b);
60     ludel(h);
61 endfunction
62 function [wp, iwp, ires] = pjac(neq, t, y, ydot, h, cj, rewt, savr)
63     ires = 0;
64     SQuround = 1.490D-08;
65     tx = t;
66     nrow = 0;
67     e = zeros(1, neq);
68     wp = zeros(neq*neq, 1);
69     iwp = zeros(neq*neq, 2);
70     for i=1:neq
71         del = max(SQuround*max(abs(y(i)), abs(h*ydot(i))), 1/rewt(i))
72         if h*ydot(i) < 0 then del = -del; end
73         ysave = y(i);
74         ypsave = ydot(i);
75         y(i) = y(i) + del;
76         ydot(i) = ydot(i) + cj*del;
77         [e ires]=res1(tx, y, ydot);
78         if ires < 0 then return; end
79         delinv = 1/del;
80         for j=1:neq
81             wp(nrow+j) = delinv*(e(j)-savr(j));
82             iwp(nrow+j,1) = i;
83             iwp(nrow+j,2) = j;
84         end
85         nrow = nrow + neq;
86         y(i) = ysave;
87         ydot(i) = ypsave;
88     end
89 endfunction
90
91 y0=1;t=2:6;t0=1;y0d=3;
92 info=list([],0,[],[],[],0,[],1,[],0,1,[],[],1);
93 atol=1.d-6;rtol=0;ng=2;
94 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,'gr1',info,psol,pjac);
95 if abs(nn(1)-2.47)>0.001 then pause,end
96 y0=yy(2,2);y0d=yy(3,2);t0=nn(1);t=[3,4,5,6];
97 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,'gr1',info,psol,pjac);
98 if abs(nn(1)-2.5)>0.001 then pause,end
99 y0=yy(2,1);y0d=yy(3,1);t0=nn(1);t=[3,4,5,6];
100 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res1,ng,'gr1',info,psol,pjac);
101 if abs(nn(1)-2.53)>0.001 then pause,end
102 info=list([],0,[],[],[],0,[],0,[],0,0,[],[],1);
103
104 //C
105 //C-----------------------------------------------------------------------
106 //C Second problem (Van Der Pol oscillator).
107 //C The initial value problem is..
108 //C   DY1/DT = Y2,  DY2/DT = 100*(1 - Y1**2)*Y2 - Y1,
109 //C   Y1(0) = 2,  Y2(0) = 0,  0 .LE. T .LE. 200
110 //C   Y1PRIME(0) = 0, Y2PRIME(0) = -2
111 //C The root function is  G = Y1.
112 //C An analytic solution is not known, but the zeros of Y1 are known
113 //C to 15 figures for purposes of checking the accuracy.
114 //C-----------------------------------------------------------------------
115 rtol=[1.d-6;1.d-6];atol=[1.d-6;1.d-4];
116 t0=0;y0=[2;0];y0d=[0;-2];t=[20:20:200];ng=1;
117 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,'res2','jac2',ng,'gr2',info);
118 if abs(nn(1)-81.163512)>0.001 then pause,end
119
120 deff('[delta,ires]=res2(t,y,ydot)',...
121 'ires=0;y1=y(1),y2=y(2),delta=[ydot-[y2;100*(1-y1*y1)*y2-y1]]')
122 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res2,'jac2',ng,'gr2',info);
123 deff('J=jac2(t,y,ydot,c)','y1=y(1);y2=y(2);J=[c,-1;200*y1*y2+1,c-100*(1-y1*y1)]')
124 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res2,jac2,ng,'gr2',info);
125 deff('s=gr2(t,y,yd)','s=y(1)')
126 [yy,nn]=daskr([y0,y0d],t0,t,atol,rtol,res2,jac2,ng,gr2,info);
127
128 //           Hot Restart
129
130 [yy,nn,hotd]=daskr([y0,y0d],t0,t,atol,rtol,'res2','jac2',ng,'gr2',info);
131 t01=nn(1);t=100:20:200;[pp,qq]=size(yy);y01=yy(2:3,qq);y0d1=yy(3:4,qq);
132 [yy,nn,hotd]=daskr([y01,y0d1],t01,t,atol,rtol,'res2','jac2',ng,'gr2',info,hotd);
133 if abs(nn(1)-162.57763)>0.004 then pause,end
134
135 //Test of Dynamic link (Require f77!)
136 //         1 making the routines
137 res22=[...
138 '      SUBROUTINE RES22(T,Y,YDOT,DELTA,IRES,RPAR,IPAR)';
139 '      IMPLICIT DOUBLE PRECISION (A-H,O-Z)';
140 '      INTEGER NEQ';
141 '      DIMENSION Y(*), YDOT(*), DELTA(*)';
142 '      NEQ=2';
143 '      CALL F2(NEQ,T,Y,DELTA)';
144 '      DO 10 I = 1,NEQ';
145 '         DELTA(I) = YDOT(I) - DELTA(I)';
146 ' 10   CONTINUE';
147 '      RETURN';
148 '      END';
149 '      SUBROUTINE F2 (NEQ, T, Y, YDOT)';
150 '      IMPLICIT DOUBLE PRECISION (A-H,O-Z)';
151 '      INTEGER NEQ';
152 '      DOUBLE PRECISION T, Y, YDOT';
153 '      DIMENSION Y(*), YDOT(*)';
154 '      YDOT(1) = Y(2)';
155 '      YDOT(2) = 100.0D0*(1.0D0 - Y(1)*Y(1))*Y(2) - Y(1)';
156 '      RETURN';
157 '      END';]
158
159 jac22=[...
160 '      SUBROUTINE JAC22 (T, Y, ydot, PD, CJ, RPAR, IPAR)';
161 ' ';
162 '      IMPLICIT DOUBLE PRECISION (A-H,O-Z)';
163 '      INTEGER  NROWPD';
164 '      DOUBLE PRECISION T, Y, PD';
165 '      PARAMETER (NROWPD=2)';
166 '      DIMENSION Y(2), PD(NROWPD,2)';
167 '      PD(1,1) = 0.0D0';
168 '      PD(1,2) = 1.0D0';
169 '      PD(2,1) = -200.0D0*Y(1)*Y(2) - 1.0D0';
170 '      PD(2,2) = 100.0D0*(1.0D0 - Y(1)*Y(1))';
171 '      PD(1,1) = CJ - PD(1,1)';
172 '      PD(1,2) =    - PD(1,2)';
173 '      PD(2,1) =    - PD(2,1)';
174 '      PD(2,2) = CJ - PD(2,2)';
175 '      RETURN';
176 '      END';]
177
178
179 gr22=[...
180 '      SUBROUTINE GR22 (NEQ, T, Y, NG, GROOT, RPAR, IPAR)';
181 '      IMPLICIT DOUBLE PRECISION (A-H,O-Z)';
182 '      INTEGER NEQ, NG';
183 '      DOUBLE PRECISION T, Y, GROOT';
184 '      DIMENSION Y(*), GROOT(*)';
185 '      GROOT(1) = Y(1)';
186 '      RETURN';
187 '      END';]
188
189 //Uncomment lines below: link may be machine dependent if some f77 libs are
190 //needed for linking
191 //unix_g('cd /tmp;rm -f /tmp/res22.f');unix_g('cd /tmp;rm -f /tmp/gr22.f');
192 //unix_g('cd /tmp;rm -f /tmp/jac22.f');
193 //write('/tmp/res22.f',res22);write('/tmp/gr22.f',gr22);write('/tmp/jac22.f',jac22)
194 //unix_g("cd /tmp;make /tmp/res22.o");unix_g('cd /tmp;make /tmp/gr22.o');
195 //unix_g('cd /tmp;make /tmp/jac22.o');
196 //          2  Linking the routines
197 //link('/tmp/res22.o','res22');link('/tmp/jac22.o','jac22');link('/tmp/gr22.o','gr22')
198 //rtol=[1.d-6;1.d-6];atol=[1.d-6;1.d-4];
199 //t0=0;y0=[2;0];y0d=[0;-2];t=[20:20:200];ng=1;
200 //          3 Calling the routines by dasrt
201 //[yy,nn]=dasrt([y0,y0d],t0,t,atol,rtol,'res22','jac22',ng,'gr22',info);
202 // hot restart
203 //[yy,nn,hotd]=dasrt([y0,y0d],t0,t,atol,rtol,'res22','jac22',ng,'gr22',info);
204 //t01=nn(1);t=100:20:200;[pp,qq]=size(yy);y01=yy(2:3,qq);y0d1=yy(3:4,qq);
205 //[yy,nn,hotd]=dasrt([y01,y0d1],t01,t,atol,rtol,'res22','jac22',ng,'gr22',info,hotd);