Update of the localization templates
[scilab.git] / scilab / modules / differential_equations / macros / daeoptions.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 2008 - INRIA - Sabine GAUZERE
3 // ...
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, which
7 // you should have received as part of this distribution.  The terms
8 // are also available at    
9 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10
11 function [%DAEOPTIONS] = daeoptions(%DAEOPTIONS)
12
13 //%DAEOPTIONS=list(tstop,imode,band,maxstep,stepin,nonneg,isest)
14 // This function displays the command line 
15 // %DAEOPTIONS=[...] to be executed 
16 // for defining the variable %DAEOPTIONS
17 // This variables sets a number of optional parameters 
18 // for the lsod* fortran routines.
19
20   //options = [1,0,0,%inf,0,2,500,12,5,0,-1,-1];
21   options = list ([],0,[],[],[],0,0);
22   //default = [string(options(1:10)),sci2exp(options(11:12))]
23   default = ["[]","0","[]","[]","[]","0","0"];
24   //default(find(default=='Inf'))="%inf"
25
26   if argn(2)>0 then
27     options=%DAEOPTIONS
28   end
29
30   //lab_=[string(options(1:10)),sci2exp(options(11:12))]
31   lab_= ["[]","0","[]","[]","[]","0","0"];
32   //lab_(find(lab_=="[]"))="[]"
33
34
35 chapeau=["Defining %DAEOPTIONS variable";
36          "*****************************";
37          'Meaning of tstop:';
38          'tstop is a real scalar which gives the maximum time'; 
39          'for which g is allowed to be evaluated';
40          '[] : if no limits imposed for time';
41          ' ';
42          'Meaning of imode:';
43          '0 : if only the user specified time point values';
44          '1 : if dae returns its intermediate computed values';
45          ' ';
46          'Meaning of band:';
47          ' ';
48          'Meaning of maxstep:';
49          ' ';
50          'Meaning of stepin:';
51          ' ';
52          'Meaning of nonneg:';
53          '0 : if the solution is known to be negative';
54          '1 : if the solution is known to be non negative';
55          ' ';
56          'Meaning of isest:';
57          '0 : if g(t0,y0,ydot0)=0';
58          '1 : if ydot0 is just an estimation';
59          ' '
60          'Default values are given in square brackets'
61          'If the function is called without argument, default values"+...
62          " are used"
63         ]
64
65 dims = list("vec",-1,"vec",1,"vec",-1,"vec",-1,"vec",-1,..
66             "vec",1,"vec",1);
67
68
69 labels = ["tstop (maximum time) ","imode (assumes imode = 0 or 1)",...
70           "band ()",...
71           "maxstep (max step size)","stepin (initial step size)",...
72           "nonneg (assumes nonneg = 0 or 1)",...
73           "isest (assumes isest = 0 or 1)"] +'    ['+default+']';
74
75 [ok,tstop,imode,band,maxstep,stepin,nonneg,isest] = getvalue(chapeau,labels,dims,lab_);
76 //ml = mlmu(1);
77 //mu = mlmu(2);
78
79 DAEOPTIONS = list(tstop,imode,band,maxstep,stepin,nonneg,isest);
80
81 if DAEOPTIONS<>list() then
82   %DAEOPTIONS=DAEOPTIONS
83 else
84   %DAEOPTIONS=options
85 end
86
87 endfunction