annotate liboctave/DASSL-opts.in @ 5103:e2ed74b9bfa0 after-gnuplot-split

[project @ 2004-12-28 02:43:01 by jwe]
author jwe
date Tue, 28 Dec 2004 02:43:01 +0000
parents bdbee5282954
children 23b37da9fd5b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
1 CLASS = "DASSL"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
2
4044
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
3 INCLUDE = "DAE.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
4
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
5 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
6 NAME = "absolute tolerance"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
7 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
8 Absolute tolerance. May be either vector or scalar. If a vector, it
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
9 must match the dimension of the state vector, and the relative
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
10 tolerance must also be a vector of the same length.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
11 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
12 TYPE = "Array<double>"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
13 SET_ARG_TYPE = "const $TYPE&"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
14 INIT_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
15 $OPTVAR.resize (1);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
16 $OPTVAR(0) = ::sqrt (DBL_EPSILON);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
17 END_INIT_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
18 SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
19 void set_$OPT (double val)
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
20 {
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
21 $OPTVAR.resize (1);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
22 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON);
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 4047
diff changeset
23 reset = true;
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
24 }
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
25
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
26 void set_$OPT (const $TYPE& val)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 4047
diff changeset
27 { $OPTVAR = val; reset = true; }
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
28 END_SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
29 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
30
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
31 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
32 NAME = "relative tolerance"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
33 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
34 Relative tolerance. May be either vector or scalar. If a vector, it
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
35 must match the dimension of the state vector, and the absolute
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
36 tolerance must also be a vector of the same length.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
37
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
38 The local error test applied at each integration step is
4051
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe]
jwe
parents: 4050
diff changeset
39
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
40 @example
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4429
diff changeset
41 abs (local error in x(i))
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4429
diff changeset
42 <= rtol(i) * abs (Y(i)) + atol(i)
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
43 @end example
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
44 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
45 TYPE = "Array<double>"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
46 SET_ARG_TYPE = "const $TYPE&"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
47 INIT_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
48 $OPTVAR.resize (1);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
49 $OPTVAR(0) = ::sqrt (DBL_EPSILON);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
50 END_INIT_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
51 SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
52 void set_$OPT (double val)
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
53 {
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
54 $OPTVAR.resize (1);
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
55 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON);
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 4047
diff changeset
56 reset = true;
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
57 }
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
58
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
59 void set_$OPT (const $TYPE& val)
4049
a35a3c5d4740 [project @ 2002-08-16 08:54:31 by jwe]
jwe
parents: 4047
diff changeset
60 { $OPTVAR = val; reset = true; }
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
61 END_SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
62 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
63
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
64 OPTION
4047
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
65 NAME = "compute consistent initial condition"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
66 DOC_ITEM
4051
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe]
jwe
parents: 4050
diff changeset
67 If nonzero, @code{dassl} will attempt to compute a consistent set of intial
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
68 conditions. This is generally not reliable, so it is best to provide
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
69 a consistent set and leave this option set to zero.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
70 END_DOC_ITEM
4047
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
71 TYPE = "int"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
72 INIT_VALUE = "0"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
73 SET_EXPR = "val"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
74 END_OPTION
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
75
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
76 OPTION
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
77 NAME = "enforce nonnegativity constraints"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
78 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
79 If you know that the solutions to your equations will always be
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
80 nonnegative, it may help to set this parameter to a nonzero
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
81 value. However, it is probably best to try leaving this option set to
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
82 zero first, and only setting it to a nonzero value if that doesn't
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
83 work very well.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
84 END_DOC_ITEM
4047
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
85 TYPE = "int"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
86 INIT_VALUE = "0"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
87 SET_EXPR = "val"
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
88 END_OPTION
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
89
7b0c139ac8af [project @ 2002-08-15 20:52:55 by jwe]
jwe
parents: 4044
diff changeset
90 OPTION
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
91 NAME = "initial step size"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
92 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
93 Differential-algebraic problems may occaisionally suffer from severe
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
94 scaling difficulties on the first step. If you know a great deal
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
95 about the scaling of your problem, you can help to alleviate this
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
96 problem by specifying an initial stepsize.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
97 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
98 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
99 INIT_VALUE = "-1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
100 SET_EXPR = "(val >= 0.0) ? val : -1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
101 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
102
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
103 OPTION
4044
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
104 NAME = "maximum order"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
105 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
106 Restrict the maximum order of the solution method. This option must
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
107 be between 1 and 5, inclusive.
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
108 END_DOC_ITEM
4044
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
109 TYPE = "int"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
110 INIT_VALUE = "-1"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
111 SET_EXPR = "val"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
112 END_OPTION
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
113
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe]
jwe
parents: 3998
diff changeset
114 OPTION
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
115 NAME = "maximum step size"
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
116 DOC_ITEM
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
117 Setting the maximum stepsize will avoid passing over very large
4051
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe]
jwe
parents: 4050
diff changeset
118 regions (default is not specified).
4050
6481f41a79f3 [project @ 2002-08-17 02:18:18 by jwe]
jwe
parents: 4049
diff changeset
119 END_DOC_ITEM
3998
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
120 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
121 INIT_VALUE = "-1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
122 SET_EXPR = "(val >= 0.0) ? val : -1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe]
jwe
parents:
diff changeset
123 END_OPTION
4429
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
124
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
125 OPTION
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
126 NAME = "step limit"
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
127 DOC_ITEM
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
128 Maximum number of integration steps to attempt on a single call to the
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
129 underlying Fortran code.
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
130 END_DOC_ITEM
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
131 TYPE = "int"
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
132 INIT_VALUE = "-1"
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
133 SET_EXPR = "(val >= 0) ? val : -1"
c1f6200b5f0e [project @ 2003-06-17 04:36:08 by jwe]
jwe
parents: 4051
diff changeset
134 END_OPTION