Mercurial > hg > octave-nkf
diff liboctave/DASSL-opts.in @ 4050:6481f41a79f3
[project @ 2002-08-17 02:18:18 by jwe]
author | jwe |
---|---|
date | Sat, 17 Aug 2002 02:18:18 +0000 |
parents | a35a3c5d4740 |
children | b79da8779a0e |
line wrap: on
line diff
--- a/liboctave/DASSL-opts.in +++ b/liboctave/DASSL-opts.in @@ -4,6 +4,11 @@ OPTION NAME = "absolute tolerance" + DOC_ITEM +Absolute tolerance. May be either vector or scalar. If a vector, it +must match the dimension of the state vector, and the relative +tolerance must also be a vector of the same length. + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" INIT_BODY @@ -25,6 +30,16 @@ OPTION NAME = "relative tolerance" + DOC_ITEM +Relative tolerance. May be either vector or scalar. If a vector, it +must match the dimension of the state vector, and the absolute +tolerance must also be a vector of the same length. + +The local error test applied at each integration step is +@example + abs (local error in x(i)) <= rtol(i) * abs (Y(i)) + atol(i) +@end example + END_DOC_ITEM TYPE = "Array<double>" SET_ARG_TYPE = "const $TYPE&" INIT_BODY @@ -46,6 +61,11 @@ OPTION NAME = "compute consistent initial condition" + DOC_ITEM +If nonzero, dassl will attempt to compute a consistent set of intial +conditions. This is generally not reliable, so it is best to provide +a consistent set and leave this option set to zero. + END_DOC_ITEM TYPE = "int" INIT_VALUE = "0" SET_EXPR = "val" @@ -53,6 +73,13 @@ OPTION NAME = "enforce nonnegativity constraints" + DOC_ITEM +If you know that the solutions to your equations will always be +nonnegative, it may help to set this parameter to a nonzero +value. However, it is probably best to try leaving this option set to +zero first, and only setting it to a nonzero value if that doesn't +work very well. + END_DOC_ITEM TYPE = "int" INIT_VALUE = "0" SET_EXPR = "val" @@ -60,6 +87,12 @@ OPTION NAME = "initial step size" + DOC_ITEM +Differential-algebraic problems may occaisionally suffer from severe +scaling difficulties on the first step. If you know a great deal +about the scaling of your problem, you can help to alleviate this +problem by specifying an initial stepsize. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" SET_EXPR = "(val >= 0.0) ? val : -1.0" @@ -67,6 +100,10 @@ OPTION NAME = "maximum order" + DOC_ITEM +Restrict the maximum order of the solution method. This option must +be between 1 and 5, inclusive. + END_DOC_ITEM TYPE = "int" INIT_VALUE = "-1" SET_EXPR = "val" @@ -74,6 +111,10 @@ OPTION NAME = "maximum step size" + DOC_ITEM +Setting the maximum stepsize will avoid passing over very large +regions. + END_DOC_ITEM TYPE = "double" INIT_VALUE = "-1.0" SET_EXPR = "(val >= 0.0) ? val : -1.0"