|
3998
|
1 CLASS = "LSODE" |
|
|
2 |
|
4044
|
3 INCLUDE = "ODE.h" |
|
|
4 |
|
3998
|
5 OPTION |
|
|
6 NAME = "absolute tolerance" |
|
4051
|
7 DOC_ITEM |
|
|
8 Absolute tolerance. May be either vector or scalar. If a vector, it |
|
|
9 must match the dimension of the state vector. |
|
|
10 END_DOC_ITEM |
|
3998
|
11 TYPE = "Array<double>" |
|
|
12 SET_ARG_TYPE = "const $TYPE&" |
|
|
13 INIT_BODY |
|
|
14 $OPTVAR.resize (1); |
|
|
15 $OPTVAR(0) = ::sqrt (DBL_EPSILON); |
|
|
16 END_INIT_BODY |
|
|
17 SET_CODE |
|
|
18 void set_$OPT (double val) |
|
|
19 { |
|
|
20 $OPTVAR.resize (1); |
|
|
21 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); |
|
4049
|
22 reset = true; |
|
3998
|
23 } |
|
|
24 |
|
|
25 void set_$OPT (const $TYPE& val) |
|
4049
|
26 { $OPTVAR = val; reset = true; } |
|
3998
|
27 END_SET_CODE |
|
|
28 END_OPTION |
|
|
29 |
|
|
30 OPTION |
|
4051
|
31 NAME = "relative tolerance" |
|
|
32 DOC_ITEM |
|
|
33 Relative tolerance parameter. Unlike the absolute tolerance, this |
|
|
34 parameter may only be a scalar. |
|
|
35 |
|
|
36 The local error test applied at each integration step is |
|
|
37 |
|
|
38 @example |
|
|
39 abs (local error in x(i)) <= rtol * abs (y(i)) + atol(i) |
|
|
40 @end example |
|
|
41 END_DOC_ITEM |
|
|
42 TYPE = "double" |
|
|
43 INIT_VALUE = "::sqrt (DBL_EPSILON)" |
|
|
44 SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)" |
|
|
45 END_OPTION |
|
|
46 |
|
|
47 OPTION |
|
3998
|
48 NAME = "integration method" |
|
4231
|
49 DOC_ITEM |
|
4051
|
50 A string specifing the method of integration to use to solve the ODE |
|
|
51 system. Valid values are |
|
|
52 |
|
|
53 @table @asis |
|
|
54 @item \"adams\" |
|
|
55 @itemx \"non-stiff\" |
|
|
56 No Jacobian used (even if it is available). |
|
|
57 @item \"bdf\" |
|
|
58 @item \"stiff\" |
|
|
59 Use stiff backward differentiation formula (BDF) method. If a |
|
|
60 function to compute the Jacobian is not supplied, @code{lsode} will |
|
|
61 compute a finite difference approximation of the Jacobian matrix. |
|
|
62 @end table |
|
|
63 END_DOC_ITEM |
|
3998
|
64 TYPE = "std::string" |
|
|
65 SET_ARG_TYPE = "const $TYPE&" |
|
|
66 INIT_VALUE = ""stiff"" |
|
|
67 SET_BODY |
|
|
68 if (val == "stiff" || val == "bdf") |
|
|
69 $OPTVAR = "stiff"; |
|
|
70 else if (val == "non-stiff" || val == "adams") |
|
|
71 $OPTVAR = "non-stiff"; |
|
|
72 else |
|
|
73 (*current_liboctave_error_handler) |
|
|
74 ("lsode_options: method must be \"stiff\", \"bdf\", \"non-stiff\", or \"adams\""); |
|
|
75 END_SET_BODY |
|
|
76 END_OPTION |
|
|
77 |
|
|
78 OPTION |
|
|
79 NAME = "initial step size" |
|
4051
|
80 DOC_ITEM |
|
|
81 The step size to be attempted on the first step (default is determined |
|
|
82 automatically). |
|
|
83 END_DOC_ITEM |
|
3998
|
84 TYPE = "double" |
|
|
85 INIT_VALUE = "-1.0" |
|
|
86 SET_EXPR = "(val >= 0.0) ? val : -1.0" |
|
|
87 END_OPTION |
|
|
88 |
|
|
89 OPTION |
|
4231
|
90 NAME = "maximum order" |
|
|
91 DOC_ITEM |
|
|
92 Restrict the maximum order of the solution method. If using the Adams |
|
|
93 method, this option must be between 1 and 12. Otherwise, it must be |
|
|
94 between 1 and 5, inclusive. |
|
|
95 END_DOC_ITEM |
|
5275
|
96 TYPE = "octave_idx_type" |
|
4231
|
97 INIT_VALUE = "-1" |
|
|
98 SET_EXPR = "val" |
|
|
99 END_OPTION |
|
|
100 |
|
|
101 OPTION |
|
3998
|
102 NAME = "maximum step size" |
|
4051
|
103 DOC_ITEM |
|
|
104 Setting the maximum stepsize will avoid passing over very large |
|
|
105 regions (default is not specified). |
|
|
106 END_DOC_ITEM |
|
3998
|
107 TYPE = "double" |
|
|
108 INIT_VALUE = "-1.0" |
|
|
109 SET_EXPR = "(val >= 0.0) ? val : -1.0" |
|
|
110 END_OPTION |
|
|
111 |
|
|
112 OPTION |
|
|
113 NAME = "minimum step size" |
|
4051
|
114 DOC_ITEM |
|
|
115 The minimum absolute step size allowed (default is 0). |
|
|
116 END_DOC_ITEM |
|
3998
|
117 TYPE = "double" |
|
|
118 INIT_VALUE = "0.0" |
|
|
119 SET_EXPR = "(val >= 0.0) ? val : 0.0" |
|
|
120 END_OPTION |
|
|
121 |
|
|
122 OPTION |
|
|
123 NAME = "step limit" |
|
4051
|
124 DOC_ITEM |
|
|
125 Maximum number of steps allowed (default is 100000). |
|
|
126 END_DOC_ITEM |
|
5275
|
127 TYPE = "octave_idx_type" |
|
3998
|
128 INIT_VALUE = "100000" |
|
|
129 SET_EXPR = "val" |
|
|
130 END_OPTION |
