04f48281adfaf5cc708f104ab21fff4f793f85a5
[scilab.git] / scilab / modules / differential_equations / tests / unit_tests / ode.tst
1 // =============================================================================
2 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3 // Copyright (C) 2007-2008 - INRIA
4 // Copyright (C) 2011 - DIGITEO - Cedric DELAMARRE
5 //
6 //  This file is distributed under the same license as the Scilab package.
7 // =============================================================================
8
9 // <-- JVM NOT MANDATORY -->
10
11 ilib_verbose(0);
12
13 version = getversion("scilab");
14
15  // to check that ode works
16  // ---------- Simple one dimension ODE (Scilab function external)
17  // dy/dt=y^2-y sin(t)+cos(t), y(0)=0
18  function ydot=f(t,y),ydot=y^2-y*sin(t)+cos(t),endfunction
19  y0=0;t0=0;t=0:0.1:%pi;
20  y=ode(y0,t0,t,f);
21 assert_checkalmostequal(size(y), [1 32] , %eps, [], "matrix");
22 clear y;
23 clear t;
24 //*************************** function F and lsoda ********************************/
25 // create functions
26 cd TMPDIR;
27
28 CC=['void fex1(int* neq, double* t, double* y, double* ydot)'
29     '{'
30     '   ydot[0] = -0.04*y[0] + 1.0e+4*y[1]*y[2];'
31     '   ydot[2] = 3.0e+7*y[1]*y[1];'
32     '   ydot[1] = -ydot[0] - ydot[2];'
33     '}'];
34 mputl(CC,TMPDIR+'/fex1.c');
35 ilib_for_link('fex1','fex1.c',[],'c');
36 exec loader.sce;
37
38 C=[ 'void fex2(int* neq, double* t, double* y, double* ydot)'
39     '{'
40     '   ydot[0] = y[4]*y[0] + y[5]*y[1]*y[2];'
41     '   ydot[2] = y[3]*y[1]*y[1];'
42     '   ydot[1] = -ydot[0] - ydot[2];'
43     '}'];
44
45 mputl(C,TMPDIR+'/fex2.c');
46 ilib_for_link('fex2','fex2.c',[],'c');
47 exec loader.sce;
48 clear f;
49 function ydot = f(t,yin)
50     ydot(1)=-0.040*yin(1) + 1.0D4*yin(2)*yin(3);
51     ydot(3)=3.0D7*yin(2)**2;
52     ydot(2)=-ydot(1) - ydot(3);
53 endfunction
54
55 function ydot = f1(t,yin,a,b,c)
56     ydot(1)=b*yin(1) + c*yin(2)*yin(3);
57     ydot(3)=a*yin(2)**2;
58     ydot(2)=-ydot(1) - ydot(3);
59 endfunction
60
61 function ydot = f2(t,yin,a)
62     ydot(1)=a(2)*yin(1) + a(3)*yin(2)*yin(3);
63     ydot(3)=a(1)*yin(2)**2;
64     ydot(2)=-ydot(1) - ydot(3);
65 endfunction
66
67 // init variables
68 y(1)    = 1;
69 y(2)    = 0;
70 y(3)    = 0;
71 t       = 0;
72 tout    = 0.4*exp((0:11)*log(10));
73 rtol    = 1.0d-4;
74 atol(1) = 1.0d-6;
75 atol(2) = 1.0d-10;
76 atol(3) = 1.0d-6;
77
78 // result provide by lsoda documentation.
79 // on a cdc-7600 in single precision.
80 //   at t =  4.0000e-01
81 resDoc(:,1) = [ 9.851712e-01 ; 3.386380e-05 ; 1.479493e-02 ];
82 //   at t =  4.0000e+00
83 resDoc(:,2) = [ 9.055333e-01 ; 2.240655e-05 ; 9.444430e-02 ];
84 //   at t =  4.0000e+01
85 resDoc(:,3) = [ 7.158403e-01 ; 9.186334e-06 ; 2.841505e-01 ];
86 //   at t =  4.0000e+02
87 resDoc(:,4) = [ 4.505250e-01 ; 3.222964e-06 ; 5.494717e-01 ];
88 //   at t =  4.0000e+03
89 resDoc(:,5) = [ 1.831975e-01 ; 8.941774e-07 ; 8.168016e-01 ];
90 //   at t =  4.0000e+04
91 resDoc(:,6) = [ 3.898730e-02 ; 1.621940e-07 ; 9.610125e-01 ];
92 //   at t =  4.0000e+05
93 resDoc(:,7) = [ 4.936363e-03 ; 1.984221e-08 ; 9.950636e-01 ];
94 //   at t =  4.0000e+06
95 resDoc(:,8) = [ 5.161831e-04 ; 2.065786e-09 ; 9.994838e-01 ];
96 //   at t =  4.0000e+07
97 resDoc(:,9) = [ 5.179817e-05 ; 2.072032e-10 ; 9.999482e-01 ];
98 //   at t =  4.0000e+08
99 resDoc(:,10) = [ 5.283401e-06 ; 2.113371e-11 ; 9.999947e-01 ];
100 //   at t =  4.0000e+09
101 resDoc(:,11) = [ 4.659031e-07 ; 1.863613e-12 ; 9.999995e-01 ];
102 //   at t =  4.0000e+10
103 resDoc(:,12) = [ 1.404280e-08 ; 5.617126e-14 ; 1.000000e+00 ];
104
105 // f as a string (dynamic link function)
106 res  = ode(y, t,tout, rtol, atol, 'fex1');
107 // f as a list(string,...
108 if version(1) > 5 then
109     res2 = ode(y, t, tout, rtol, atol, list('fex2', 3.0d+7, -0.04, 1.0d+4));
110 end
111 // f as a macro
112 res3 = ode(y, t, tout, rtol, atol, f);
113 // f as a list(macro,...
114 res4 = ode(y, t, tout, rtol, atol, list(f1, 3.0d+7, -0.04, 1.0d+4));
115 args = [ 3.0d+7, -0.04, 1.0d+4 ];
116 res5 = ode(y, t, tout, rtol, atol, list(f2, args));
117 // f as a string (static link function)
118 res6 = ode(y, t,tout, rtol, atol, 'fex');
119
120 // check results
121 assert_checkalmostequal(resDoc, res, 2d-7, [], "matrix"); // There are a little diff between resDoc and res
122 if version(1) > 5 then
123     assert_checkalmostequal(res, res2, 2d-7, [], "matrix"); // because results provides by lsoda 
124 end
125 assert_checkalmostequal(res, res3, 2d-7, [], "matrix"); // documentation are in single precision.
126 assert_checkalmostequal(res, res4, 2d-7, [], "matrix");
127 assert_checkalmostequal(res, res5, 2d-7, [], "matrix");
128 assert_checkalmostequal(res, res6, 2d-7, [], "matrix");
129
130 //*************************** w iw ********************************/
131 tout2 = 0.4*exp(12*log(10));
132 tout3 = 0.4*exp((0:12)*log(10));
133 [yout w iw] = ode(y, t, tout, rtol, atol, f);
134 yout1 = ode(y, t, tout2, rtol, atol, f, w, iw);
135 yout2 = ode(y, t, tout3, rtol, atol, f);
136
137 assert_checkalmostequal(yout2(3*12+1:3*13), yout1, %eps, [], "matrix");
138
139 //*************************** Polynom ********************************/
140 //y(1) = 1;
141 //y(2) = 2;
142 //y(3) = 3;
143 //yy   = 1+2*%s+3*%s*%s;
144
145 //res  = ode(y, t,tout, rtol, atol, 'fex1');
146
147 //res6  = ode(yy, t, tout, rtol, atol, 'fex1');
148 //for i=1:12, assert_checkalmostequal(poly(res(:,i), "s", "coeff"),res6(i), %eps); end
149 //res7 = ode(yy, t, tout, rtol, atol, list('fex2', 3.0d+7, -0.04, 1.0d+4));
150 //for i=1:12, assert_checkequal(poly(res(:,i), "s", "coeff"), res7(i), %eps); end
151
152 //*************************** function Jac and lsode ********************************/
153 CC=['void jac(int* neq, double* t, double* y, int* mu, int* ml, double* j, int nj)'
154     '{'
155     '  j[0] = y[6]; '
156     '  j[1] = y[7]; '
157     '  j[2] = y[8]; '
158     '  j[3] = y[9]; '
159     '}'];
160
161 mputl(CC,TMPDIR+'/jac.c');
162 ilib_for_link('jac','jac.c',[],'c');
163 exec loader.sce;
164
165 CC=['void jac2(int* neq, double* t, double* y, int* mu, int* ml, double* j, int nj)'
166     '{'
167     '  j[0] = 10; '
168     '  j[1] = 0; '
169     '  j[2] = 0; '
170     '  j[3] = -1; '
171     '}'];
172 mputl(CC,TMPDIR+'/jac2.c');
173 ilib_for_link('jac2','jac2.c',[],'c');
174 exec loader.sce;
175
176 // ydot = A * y
177 C=[ 'void fext(int* neq, double* t, double* y, double* ydot)'
178     '{'
179     '   ydot[0] = y[2]*y[0] + y[4]*y[1];'
180     '   ydot[1] = y[3]*y[0] + y[5]*y[1];'
181     '}'];
182
183 mputl(C,TMPDIR+'/fext.c');
184 ilib_for_link('fext','fext.c',[],'c');
185 exec loader.sce;
186
187 C=[ 'void fext2(int* neq, double* t, double* y, double* ydot)'
188     '{'
189     '   ydot[0] = 10*y[0] + 0*y[1];'
190     '   ydot[1] = 0*y[0] + (-1)*y[1];'
191     '}'];
192
193 mputl(C,TMPDIR+'/fext2.c');
194 ilib_for_link('fext2','fext2.c',[],'c');
195 exec loader.sce;
196 clear f;
197 function ydot=f(t, y)
198     ydot=A*y
199 endfunction
200
201 function J=Jacobian(t, y)
202     J=A
203 endfunction
204
205 A=[10,0;0,-1];
206 y0=[0;1];
207 t0=0;
208 t=1;
209
210 res  = ode("stiff", y0, t0, t, f, Jacobian);
211 if version(1) > 5 then
212     res1 = ode("stiff", y0, t0, t, list('fext', 10, 0, 0,-1), list('jac', A));
213 end
214 res2 = ode("stiff", y0, t0, t, 'fext2', 'jac2');
215 res3 = ode("stiff", y0, t0, t, f, 'jac2');
216 res4 = ode("stiff", y0, t0, t, 'fext2', Jacobian);
217
218 assert_checkalmostequal(res, expm(A*t)*y0, 1.0D-7, [], "matrix");
219 if version(1) > 5 then
220     assert_checkalmostequal(res, res1, %eps, [], "matrix");
221 end
222 assert_checkalmostequal(res, res2, %eps, [], "matrix");
223 assert_checkalmostequal(res, res3, %eps, [], "matrix");
224 assert_checkalmostequal(res, res4, %eps, [], "matrix");
225
226 //*************************** discrete ********************************/
227 function yp=a_function(k,y)
228     yp=A*y+B*u(k);
229 endfunction
230
231 y1 = [1;2;3];
232 A  = diag([0.2,0.5,0.9]);
233 B  = [1;1;1];
234 u  = 1:10;
235 n  = 5;
236
237 y =ode("discrete", y1, 1, 1:n, a_function);
238 for i = 1:4, y1(:,i+1) = A * y1(:,i) + B * u(i); end
239 assert_checkalmostequal(y, y1, %eps, [], "matrix");
240
241 // Now y evaluates  at [y3,y5,y7,y9]
242 y1 = [1;2;3];
243 t  = 3:2:9;
244 y  = ode("discrete", y1, 1, t, a_function);
245 for i=1:9, y1(:,i+1) = A * y1(:,i) + B * u(i); end
246 y1 = y1(:,t);
247 assert_checkalmostequal(y, y1, %eps, [], "matrix");
248
249 //*************************** root ********************************/
250 y0=1;
251 ng=1;
252
253 C=[ 'void fextern(int* neq, double* t, double* y, double* ydot)'
254     '{'
255     'int i = 0;'
256     'for( i = 0; i < *neq; i++)'
257     '   ydot[i] = y[i];'
258     '}'];
259
260 mputl(C,TMPDIR+'/fextern.c');
261 ilib_for_link('fextern','fextern.c',[],'c');
262 exec loader.sce;
263 clear f;
264 function ydot=f(t,y)
265     ydot=y;
266 endfunction
267
268 clear g;
269 // check rd result
270 function z=g(t,y)
271 z=y-2;
272 endfunction
273 [y,rd]=ode("root",y0,0,2,f,ng,g);
274 assert_checkequal( rd(2) <> 1 , %f);
275
276 clear g;
277 function z=g(t,y)
278 z=y-[2;2;33];
279 endfunction
280 [y,rd]=ode("root",y0,0,2,f,3,g);
281 assert_checkequal( rd(2) <> 1 , %f);
282 assert_checkequal( rd(3) <> 2 , %f);
283
284 clear g;
285 function z=g(t,y)
286 z=y-[2;2;2];
287 endfunction
288 [y,rd]=ode("root",y0,0,2,f,3,g);
289 assert_checkequal( rd(2) <> 1 , %f);
290 assert_checkequal( rd(3) <> 2 , %f);
291 assert_checkequal( rd(4) <> 3 , %f);
292
293 clear g;
294 function z=g(t,y)
295 z=y-[2;6;2;2];
296 endfunction
297 [y,rd]=ode("root",y0,0,2,f,4,g);
298 assert_checkequal( rd(2) <> 1 , %f);
299 assert_checkequal( rd(3) <> 3 , %f);
300 assert_checkequal( rd(4) <> 4 , %f);
301
302 // check y result
303
304 // result provide by lsodar documentation.
305 // on a cdc-7600 in single precision.
306 //   at t =  2.6400e-01
307 resDocRoot(:,1) = [ 9.899653e-01 ; 3.470563e-05 ; 1.000000e-02 ];
308 //        the above line is a root,  jroot =    0    1
309 //   at t =  4.0000e-01
310 resDoc(:,1) = [ 9.851712e-01 ; 3.386380e-05 ; 1.479493e-02 ];
311 //   at t =  4.0000e+00
312 resDoc(:,2) = [ 9.055333e-01 ; 2.240655e-05 ; 9.444430e-02 ];
313 //   at t =  4.0000e+01
314 resDoc(:,3) = [ 7.158403e-01 ; 9.186334e-06 ; 2.841505e-01 ];
315 //   at t =  4.0000e+02
316 resDoc(:,4) = [ 4.505250e-01 ; 3.222964e-06 ; 5.494717e-01 ];
317 //   at t =  4.0000e+03
318 resDoc(:,5) = [ 1.831975e-01 ; 8.941774e-07 ; 8.168016e-01 ];
319 //   at t =  4.0000e+04
320 resDoc(:,6) = [ 3.898730e-02 ; 1.621940e-07 ; 9.610125e-01 ];
321 //   at t =  4.0000e+05
322 resDoc(:,7) = [ 4.936363e-03 ; 1.984221e-08 ; 9.950636e-01 ];
323 //   at t =  4.0000e+06
324 resDoc(:,8) = [ 5.161831e-04 ; 2.065786e-09 ; 9.994838e-01 ];
325 //   at t =  2.0745e+07
326 resDocRoot(:,2) = [ 1.000000e-04 ; 4.000395e-10 ; 9.999000e-01 ];
327 //        the above line is a root,  jroot =    1    0
328 //   at t =  4.0000e+07
329 resDoc(:,9) = [ 5.179817e-05 ; 2.072032e-10 ; 9.999482e-01 ];
330 //   at t =  4.0000e+08
331 resDoc(:,10) = [ 5.283401e-06 ; 2.113371e-11 ; 9.999947e-01 ];
332 //   at t =  4.0000e+09
333 resDoc(:,11) = [ 4.659031e-07 ; 1.863613e-12 ; 9.999995e-01 ];
334 //   at t =  4.0000e+10
335 resDoc(:,12) = [ 1.404280e-08 ; 5.617126e-14 ; 1.000000e+00 ];
336
337 G=[ 'void gex(int* neq, double* t, double* y, int* ng, double* gout)'
338     '{'
339         'gout[0] = y[0] - 1.0e-4;'
340         'gout[1] = y[2] - 1.0e-2;'
341     '}'];
342
343 mputl(G,TMPDIR+'/gex.c');
344 ilib_for_link('gex','gex.c',[],'c');
345 exec loader.sce;
346
347 y(1) = 1;
348 y(2) = 0;
349 y(3) = 0;
350 t0   = 0;
351
352 [yout1,rd1,w,iw] = ode("root", y, t0, tout, 'fex1', 2, 'gex');
353 assert_checkalmostequal(rd1(1), 2.64d-01, 1d-4);
354 [yout2,rd2,w,iw] = ode("root", y, t0, tout, 'fex1', 2, 'gex', w, iw);
355 assert_checkalmostequal(rd2(1), 2.0795776d+07, 1d-7);
356 err = execstr("[yout3,rd,w,iw] = ode(""root"", y, t0, tout, ""fex1"", 2, ""gex"", w, iw);","errcatch");
357 assert_checkequal( err == 0 , %f);
358
359 // check results
360 assert_checkalmostequal(resDocRoot(:,1), yout1, 2.0D-8, [], "matrix");
361 assert_checkalmostequal(resDocRoot(:,2), yout2(:,9), 2.0D-8, [], "matrix");
362 assert_checkalmostequal(resDoc(:,1:8), yout2(:,1:8), 2.0D-4, [], "matrix");
363
364 //*************************** rk/rkf/fix ********************************/
365 function ydot=functionF(t, y)
366     ydot=y^2-y*sin(t)+cos(t)
367 endfunction
368
369 y0 = 0;
370 t0 = 0;
371 t  = 0:0.1:%pi;
372
373 rk   = ode("rk",  y0, t0, t, functionF);
374 rkf  = ode("rkf", y0, t0, t, functionF);
375 fixx = ode("fix", y0, t0, t, functionF);
376
377 rkRes = [0.    0.09983341664683527    0.19866933079512300    0.29552020666153711 0.38941834230905709    0.47942553860493514    0.56464247339623352    0.64421768723947215 0.71735609090195429    0.78332690963060869    0.8414709848117728     0.89120736006615475 0.93203908597292051    0.96355818542403104    0.98544972999664104    0.99749498661376];
378 rkRes(17:32) = [0.99957360305287668    0.99166481046564392    0.97384763089330029    0.94630008770455387 0.90929742684492987    0.86320936667026738    0.80849640384312127    0.74570521220233155 0.67546318057873300    0.59847214413334937    0.51550137185246248    0.42737988026620155 0.33498815018939587    0.23924932924832210    0.14112000809477554    0.04158066246848785];
379
380 rkfRes = [0.    0.09983341667063099    0.19866933087782307    0.2955202068043328    0.38941834246046680     0.47942553864900261    0.56464247314940919    0.64421768645637856    0.71735608928892303      0.78332690686480611    0.84147098056308622    0.89120735401875306    0.93203907784361117      0.96355817497519225    0.98544971704249074    0.99749497101988072    0.99957358472991464];
381 rkfRes(18:32) = [    0.99166478935902302    0.97384760697150774    0.94630006094857066    0.90929739724116376     0.86320933420871493    0.80849636852157181    0.74570517403636893    0.67546313961625104      0.59847210047141619    0.51550132565379336    0.42737983177229999    0.33498809972769594      0.23924927723128114    0.14111995500988161    0.04158060885936282];
382
383 assert_checkalmostequal(rkRes, rk, %eps, [], "matrix");
384 assert_checkalmostequal(rkfRes, rkf, %eps, [], "matrix");
385 assert_checkalmostequal(rkf, fixx, %eps, [], "matrix");
386