Mercurial > octave-nkf
annotate liboctave/DASRT-opts.in @ 14026:3781981be535 ss-3-5-90
snapshot 3.5.90
* configure.ac (AC_INIT): Version is now 3.5.90.
(OCTAVE_API_VERSION_NUMBER): Now 46.
(OCTAVE_RELEASE_DATE): Now 2011-12-11.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sun, 11 Dec 2011 23:18:31 -0500 |
| parents | e81ddf9cacd5 |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 11523 | 1 # Copyright (C) 2002-2011 John W. Eaton |
| 7017 | 2 # |
| 3 # This file is part of Octave. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
4 # |
| 7017 | 5 # Octave is free software; you can redistribute it and/or modify it |
| 6 # under the terms of the GNU General Public License as published by the | |
| 7 # Free Software Foundation; either version 3 of the License, or (at | |
| 8 # your option) any later version. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
9 # |
| 7017 | 10 # Octave is distributed in the hope that it will be useful, but WITHOUT |
| 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 # for more details. | |
|
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11574
diff
changeset
|
14 # |
| 7017 | 15 # You should have received a copy of the GNU General Public License |
| 16 # along with Octave; see the file COPYING. If not, see | |
| 17 # <http://www.gnu.org/licenses/>. | |
| 18 | |
| 3998 | 19 CLASS = "DASRT" |
| 20 | |
| 4044 | 21 INCLUDE = "DAERT.h" |
| 22 | |
| 3998 | 23 OPTION |
| 24 NAME = "absolute tolerance" | |
| 4050 | 25 DOC_ITEM |
| 26 Absolute tolerance. May be either vector or scalar. If a vector, it | |
| 27 must match the dimension of the state vector, and the relative | |
| 28 tolerance must also be a vector of the same length. | |
| 10840 | 29 |
| 4050 | 30 END_DOC_ITEM |
| 3998 | 31 TYPE = "Array<double>" |
| 32 SET_ARG_TYPE = "const $TYPE&" | |
| 33 INIT_BODY | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
34 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 35 $OPTVAR(0) = ::sqrt (DBL_EPSILON); |
| 36 END_INIT_BODY | |
| 37 SET_CODE | |
| 38 void set_$OPT (double val) | |
| 39 { | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
40 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 41 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); |
| 4049 | 42 reset = true; |
| 3998 | 43 } |
| 44 | |
| 45 void set_$OPT (const $TYPE& val) | |
| 4049 | 46 { $OPTVAR = val; reset = true; } |
| 3998 | 47 END_SET_CODE |
| 48 END_OPTION | |
| 49 | |
| 50 OPTION | |
| 51 NAME = "relative tolerance" | |
| 4050 | 52 DOC_ITEM |
| 53 Relative tolerance. May be either vector or scalar. If a vector, it | |
| 54 must match the dimension of the state vector, and the absolute | |
| 55 tolerance must also be a vector of the same length. | |
| 56 | |
| 57 The local error test applied at each integration step is | |
| 10840 | 58 |
| 4050 | 59 @example |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7081
diff
changeset
|
60 @group |
| 7081 | 61 abs (local error in x(i)) <= ... |
| 62 rtol(i) * abs (Y(i)) + atol(i) | |
|
9067
8970b4b10e9f
Cleanup documentation for quad.texi and diffeq.texi
Rik <rdrider0-list@yahoo.com>
parents:
7081
diff
changeset
|
63 @end group |
| 4050 | 64 @end example |
| 10840 | 65 |
| 4050 | 66 END_DOC_ITEM |
| 3998 | 67 TYPE = "Array<double>" |
| 68 SET_ARG_TYPE = "const $TYPE&" | |
| 69 INIT_BODY | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
70 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 71 $OPTVAR(0) = ::sqrt (DBL_EPSILON); |
| 72 END_INIT_BODY | |
| 73 SET_CODE | |
| 74 void set_$OPT (double val) | |
| 75 { | |
|
11574
a83bad07f7e3
attempt better backward compatibility for Array resize functions
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
76 $OPTVAR.resize (dim_vector (1, 1)); |
| 3998 | 77 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (DBL_EPSILON); |
| 4049 | 78 reset = true; |
| 3998 | 79 } |
| 80 | |
| 81 void set_$OPT (const $TYPE& val) | |
| 4049 | 82 { $OPTVAR = val; reset = true; } |
| 3998 | 83 END_SET_CODE |
| 84 END_OPTION | |
| 85 | |
| 86 OPTION | |
| 87 NAME = "initial step size" | |
| 4050 | 88 DOC_ITEM |
| 7001 | 89 Differential-algebraic problems may occasionally suffer from severe |
| 4050 | 90 scaling difficulties on the first step. If you know a great deal |
| 91 about the scaling of your problem, you can help to alleviate this | |
| 92 problem by specifying an initial stepsize. | |
| 10840 | 93 |
| 4050 | 94 END_DOC_ITEM |
| 3998 | 95 TYPE = "double" |
| 96 INIT_VALUE = "-1.0" | |
| 97 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 98 END_OPTION | |
| 99 | |
| 100 OPTION | |
| 4049 | 101 NAME = "maximum order" |
| 4050 | 102 DOC_ITEM |
| 103 Restrict the maximum order of the solution method. This option must | |
| 104 be between 1 and 5, inclusive. | |
| 10840 | 105 |
| 4050 | 106 END_DOC_ITEM |
| 5275 | 107 TYPE = "octave_idx_type" |
| 4049 | 108 INIT_VALUE = "-1" |
| 109 SET_EXPR = "val" | |
| 110 END_OPTION | |
| 111 | |
| 112 OPTION | |
| 3998 | 113 NAME = "maximum step size" |
| 4050 | 114 DOC_ITEM |
| 115 Setting the maximum stepsize will avoid passing over very large | |
| 116 regions. | |
| 10840 | 117 |
| 4050 | 118 END_DOC_ITEM |
| 3998 | 119 TYPE = "double" |
| 120 INIT_VALUE = "-1.0" | |
| 121 SET_EXPR = "(val >= 0.0) ? val : -1.0" | |
| 122 END_OPTION | |
| 123 | |
| 124 OPTION | |
| 125 NAME = "step limit" | |
| 4050 | 126 DOC_ITEM |
| 127 Maximum number of integration steps to attempt on a single call to the | |
| 128 underlying Fortran code. | |
| 129 END_DOC_ITEM | |
| 5275 | 130 TYPE = "octave_idx_type" |
| 3998 | 131 INIT_VALUE = "-1" |
| 132 SET_EXPR = "(val >= 0) ? val : -1" | |
| 133 END_OPTION |