Mercurial > octave

comparison liboctave/LSODE-opts.in @ 4051:b79da8779a0e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2002-08-17 19:38:32 by jwe]
author jwe
date Sat, 17 Aug 2002 19:38:33 +0000
parents a35a3c5d4740
children 1032fb9ec0d1
comparison
equal deleted inserted replaced
4050:6481f41a79f3 4051:b79da8779a0e
2 2
3 INCLUDE = "ODE.h" 3 INCLUDE = "ODE.h"
4 4
5 OPTION 5 OPTION
6 NAME = "absolute tolerance" 6 NAME = "absolute tolerance"
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
7 TYPE = "Array<double>" 11 TYPE = "Array<double>"
8 SET_ARG_TYPE = "const $TYPE&" 12 SET_ARG_TYPE = "const $TYPE&"
9 INIT_BODY 13 INIT_BODY
10 $OPTVAR.resize (1); 14 $OPTVAR.resize (1);
11 $OPTVAR(0) = ::sqrt (DBL_EPSILON); 15 $OPTVAR(0) = ::sqrt (DBL_EPSILON);
22 { $OPTVAR = val; reset = true; } 26 { $OPTVAR = val; reset = true; }
23 END_SET_CODE 27 END_SET_CODE
24 END_OPTION 28 END_OPTION
25 29
26 OPTION 30 OPTION
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
27 NAME = "integration method" 48 NAME = "integration method"
49 A string specifing the method of integration to use to solve the ODE
50 system. Valid values are
51
52 @table @asis
53 @item \"adams\"
54 @itemx \"non-stiff\"
55 No Jacobian used (even if it is available).
56 @item \"bdf\"
57 @item \"stiff\"
58 Use stiff backward differentiation formula (BDF) method. If a
59 function to compute the Jacobian is not supplied, @code{lsode} will
60 compute a finite difference approximation of the Jacobian matrix.
61 @end table
62 DOC_ITEM
63 END_DOC_ITEM
28 TYPE = "std::string" 64 TYPE = "std::string"
29 SET_ARG_TYPE = "const $TYPE&" 65 SET_ARG_TYPE = "const $TYPE&"
30 INIT_VALUE = ""stiff"" 66 INIT_VALUE = ""stiff""
31 SET_BODY 67 SET_BODY
32 if (val == "stiff" || val == "bdf") 68 if (val == "stiff" || val == "bdf")
39 END_SET_BODY 75 END_SET_BODY
40 END_OPTION 76 END_OPTION
41 77
42 OPTION 78 OPTION
43 NAME = "initial step size" 79 NAME = "initial step size"
80 DOC_ITEM
81 The step size to be attempted on the first step (default is determined
82 automatically).
83 END_DOC_ITEM
44 TYPE = "double" 84 TYPE = "double"
45 INIT_VALUE = "-1.0" 85 INIT_VALUE = "-1.0"
46 SET_EXPR = "(val >= 0.0) ? val : -1.0" 86 SET_EXPR = "(val >= 0.0) ? val : -1.0"
47 END_OPTION 87 END_OPTION
48 88
49 OPTION 89 OPTION
50 NAME = "maximum step size" 90 NAME = "maximum step size"
91 DOC_ITEM
92 Setting the maximum stepsize will avoid passing over very large
93 regions (default is not specified).
94 END_DOC_ITEM
51 TYPE = "double" 95 TYPE = "double"
52 INIT_VALUE = "-1.0" 96 INIT_VALUE = "-1.0"
53 SET_EXPR = "(val >= 0.0) ? val : -1.0" 97 SET_EXPR = "(val >= 0.0) ? val : -1.0"
54 END_OPTION 98 END_OPTION
55 99
56 OPTION 100 OPTION
57 NAME = "minimum step size" 101 NAME = "minimum step size"
102 DOC_ITEM
103 The minimum absolute step size allowed (default is 0).
104 END_DOC_ITEM
58 TYPE = "double" 105 TYPE = "double"
59 INIT_VALUE = "0.0" 106 INIT_VALUE = "0.0"
60 SET_EXPR = "(val >= 0.0) ? val : 0.0" 107 SET_EXPR = "(val >= 0.0) ? val : 0.0"
61 END_OPTION 108 END_OPTION
62 109
63 OPTION 110 OPTION
64 NAME = "relative tolerance"
65 TYPE = "double"
66 INIT_VALUE = "::sqrt (DBL_EPSILON)"
67 SET_EXPR = "(val > 0.0) ? val : ::sqrt (DBL_EPSILON)"
68 END_OPTION
69
70 OPTION
71 NAME = "step limit" 111 NAME = "step limit"
112 DOC_ITEM
113 Maximum number of steps allowed (default is 100000).
114 END_DOC_ITEM
72 TYPE = "int" 115 TYPE = "int"
73 INIT_VALUE = "100000" 116 INIT_VALUE = "100000"
74 SET_EXPR = "val" 117 SET_EXPR = "val"
75 END_OPTION 118 END_OPTION