Reorganization
[scilab.git] / scilab / modules / differential_equations / macros / odeoptions.sci
1 function [%ODEOPTIONS]=odeoptions(%ODEOPTIONS)
2 // Copyright INRIA
3
4   options=[1,0,0,%inf,0,2,500,12,5,0,-1,-1];
5   default=[string(options(1:10)),sci2exp(options(11:12))]
6   default(find(default=='Inf'))="%inf"
7   if argn(2)>0 then
8     options=%ODEOPTIONS
9   end
10   lab_=[string(options(1:10)),sci2exp(options(11:12))]
11   lab_(find(lab_=='Inf'))="%inf"
12 //%ODEOPTIONS=[itask,tcrit,h0,hmax,hmin,jactyp,mxstep,..
13 //             maxordn,maxords,ixpr, ml,mu]
14 // This function displays the command line 
15 // %ODEOPTIONS=[...] to be executed 
16 // for defining the variable %ODEOPTIONS
17 // This variables sets a number of optional parameters 
18 // for the lsod* fortran routines.
19 load(SCI+'/macros/scicos/lib')
20 chapeau=["Defining %ODEOPTIONS variable";
21          "*****************************";
22          'Meaning of itask and tcrit:';
23          '1 : normal computation at specified times';
24          '2 : computation at mesh points (given in first row of output of ode)';
25          '3 : one step at one internal mesh point and return';
26          '4 : normal computation without overshooting tcrit';
27          '5 : one step, without passing tcrit, and return';
28          ' ';
29          'Meaning of jactype:';
30          '0 : functional iterations (no jacobian used (''adams'' or ''stiff'' only))';
31          '1 : user-supplied full jacobian';
32          '2 : internally generated full jacobian';
33          '3 : internally generated diagonal jacobian (''adams'' or ''stiff'' only))';
34          '4 : user-supplied banded jacobian (see ml,mu)';
35          '5 : internally generated banded jacobian (see ml,mu)';
36          ' ';
37          'Meaning of ml,mu:';
38          'If jactype = 4 or 5 ml and mu are the lower and upper half-banwidths';
39          'of the banded jacobian: the band is the i,j''s with i-ml <= j <= ny-1';
40          'If jactype = 4 the jacobian function must return';
41          'a matrix J which is  ml+mu+1 x ny (where ny=dim of y in ydot=f(t,y));'
42          'such that column 1 of J is made of mu zeros followed by';
43          'df1/dy1, df2/dy1, df3/dy1,... (1+ml possibly non-zero entries)';
44          'column 2 is made of mu-1 zeros followed by df1/dx2, df2/dx2,etc';
45          ' '
46          'Default values are given in square brackets'
47          'If the function is called without argument, default values"+...
48          " are used"
49         ]
50
51 dims=list("vec",1,"vec",1,"vec",1,"vec",1,"vec",1,..
52           "vec",1,"vec",1,"vec",1,"vec",1,"vec",1,"vec",2);
53
54
55 labels=["itask (1,2,3,4,5) ","tcrit (assumes itask=4 or 5)",...
56     "h0 (first step tried)",...
57     "hmax (max step size)","hmin (min step size)",...
58     "jactype (0,1,2,3,4,5)","mxstep (max number of steps allowed)",...
59     "maxordn (maximum non-stiff order allowed, at most 12)",...
60     "maxords(maximum stiff order allowed, at most 5) ",...
61     "ixpr (print level 0 or 1)","[ml,mu]"] +'    ['+default+']';
62
63 [ok,itask,tcrit,h0,hmax,hmin,jactyp,mxstep,maxordn,maxords,ixpr,mlmu]=..
64     tk_getvalue(chapeau,labels,dims,lab_);
65 ml=mlmu(1);mu=mlmu(2);
66 ODEOPTIONS=[itask,tcrit,h0,hmax,hmin,jactyp,mxstep,maxordn,maxords,ixpr, ...
67          ml,mu];
68 if ODEOPTIONS<>[] then
69   %ODEOPTIONS=ODEOPTIONS
70 else
71   %ODEOPTIONS=options
72 end
73 endfunction