octave: liboctave/numeric/LSODE-opts.in annotate

annotate liboctave/numeric/LSODE-opts.in @ 31249:de6fc38c78c6

Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). * liboctave/numeric/LSODE-opts.in: Add options "jacobian type", "lower jacobian subdiagonals", and "upper jacobian subdiagonals". * liboctave/numeric/LSODE.cc (file scope, lsode_j, LSODE::do_integrate (double)): Handle new configurable Jacobian types. * build-aux/mk-opts.pl: Don't implicitly convert to integer in condition.

author	Olaf Till <olaf.till@uni-jena.de>
date	Fri, 12 Nov 2010 08:53:05 +0100
parents	796f54d4ddbf
children	a40c0b7aa376

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
29357 bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	2 ##
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30046 diff changeset	3 ## Copyright (C) 2002-2022 The Octave Project Developers
29357 bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	4 ##
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	7 ##
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	8 ## This file is part of Octave.
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	9 ##
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	11 ## under the terms of the GNU General Public License as published by
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	13 ## (at your option) any later version.
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	14 ##
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	18 ## GNU General Public License for more details.
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	19 ##
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	20 ## You should have received a copy of the GNU General Public License
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	22 ## <https://www.gnu.org/licenses/>.
bbbe4dcc7200 use the same comment style for copyright headers in .m files and shell scripts John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	23 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7007 diff changeset	25
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	26 CLASS = "LSODE"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	27
4044 9678c5526190 [project @ 2002-08-15 16:54:55 by jwe] jwe parents: 3998 diff changeset	28 INCLUDE = "ODE.h"
9678c5526190 [project @ 2002-08-15 16:54:55 by jwe] jwe parents: 3998 diff changeset	29
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	30 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	31 NAME = "absolute tolerance"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	32 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	33 Absolute tolerance. May be either vector or scalar. If a vector, it
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	34 must match the dimension of the state vector.
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	35
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	36 END_DOC_ITEM
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	37 TYPE = "Array<double>"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	38 SET_ARG_TYPE = "const $TYPE&"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	39 INIT_BODY
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));
15220 61822c866ba1 use std::numeric_limits<T>::epsilon in C++ code John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	41 $OPTVAR(0) = ::sqrt (std::numeric_limits<double>::epsilon ());
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	42 END_INIT_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	43 SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	44 void set_$OPT (double val)
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	45 {
11574 a83bad07f7e3 attempt better backward compatibility for Array resize functions John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	46 $OPTVAR.resize (dim_vector (1, 1));
15220 61822c866ba1 use std::numeric_limits<T>::epsilon in C++ code John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	47 $OPTVAR(0) = (val > 0.0) ? val : ::sqrt (std::numeric_limits<double>::epsilon ());
30046 b3717fd85e49 maint: use "m_" prefix for member variables ODE/DAE classes in liboctave/numeric. Rik <rik@octave.org> parents: 29358 diff changeset	48 m_reset = true;
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	49 }
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	50
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	51 void set_$OPT (const $TYPE& val)
30046 b3717fd85e49 maint: use "m_" prefix for member variables ODE/DAE classes in liboctave/numeric. Rik <rik@octave.org> parents: 29358 diff changeset	52 { $OPTVAR = val; m_reset = true; }
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	53 END_SET_CODE
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	54 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	55
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	56 OPTION
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	57 NAME = "relative tolerance"
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	58 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	59 Relative tolerance parameter. Unlike the absolute tolerance, this
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	60 parameter may only be a scalar.
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	61
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	62 The local error test applied at each integration step is
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	63
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	64 @example
9067 8970b4b10e9f Cleanup documentation for quad.texi and diffeq.texi Rik <rdrider0-list@yahoo.com> parents: 7081 diff changeset	65 @group
7081 503001863427 [project @ 2007-10-31 01:08:14 by jwe] jwe parents: 7017 diff changeset	66 abs (local error in x(i)) <= ...
503001863427 [project @ 2007-10-31 01:08:14 by jwe] jwe parents: 7017 diff changeset	67 rtol * abs (y(i)) + atol(i)
9067 8970b4b10e9f Cleanup documentation for quad.texi and diffeq.texi Rik <rdrider0-list@yahoo.com> parents: 7081 diff changeset	68 @end group
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	69 @end example
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	70
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	71 END_DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	72 TYPE = "double"
15220 61822c866ba1 use std::numeric_limits<T>::epsilon in C++ code John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	73 INIT_VALUE = "::sqrt (std::numeric_limits<double>::epsilon ())"
61822c866ba1 use std::numeric_limits<T>::epsilon in C++ code John W. Eaton <jwe@octave.org> parents: 14138 diff changeset	74 SET_EXPR = "(val > 0.0) ? val : ::sqrt (std::numeric_limits<double>::epsilon ())"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	75 END_OPTION
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	76
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	77 OPTION
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	78 NAME = "integration method"
4231 1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	79 DOC_ITEM
7007 6304d9ea0a30 [project @ 2007-10-11 16:26:36 by jwe] jwe parents: 5275 diff changeset	80 A string specifying the method of integration to use to solve the ODE
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	81 system. Valid values are
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	82
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	83 @table @asis
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	84 @item @qcode{"adams"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	85 @itemx @qcode{"non-stiff"}
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	86 No Jacobian used (even if it is available).
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	87
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	88 @item @qcode{"bdf"}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 19697 diff changeset	89 @itemx @qcode{"stiff"}
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	90 Use stiff backward differentiation formula (BDF) method. If a
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	91 function to compute the Jacobian is not supplied, @code{lsode} will
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	92 compute a finite difference approximation of the Jacobian matrix.
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	93 @end table
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	94
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	95 END_DOC_ITEM
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	96 TYPE = "std::string"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	97 SET_ARG_TYPE = "const $TYPE&"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	98 INIT_VALUE = ""stiff""
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	99 SET_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	100 if (val == "stiff" \|\| val == "bdf")
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	101 $OPTVAR = "stiff";
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	102 else if (val == "non-stiff" \|\| val == "adams")
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	103 $OPTVAR = "non-stiff";
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	104 else
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	105 (*current_liboctave_error_handler)
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	106 ("lsode_options: method must be \"stiff\", \"bdf\", \"non-stiff\", or \"adams\"");
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	107 END_SET_BODY
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	108 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	109
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	110 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	111 NAME = "initial step size"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	112 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	113 The step size to be attempted on the first step (default is determined
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	114 automatically).
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	115
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	116 END_DOC_ITEM
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	117 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	118 INIT_VALUE = "-1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	119 SET_EXPR = "(val >= 0.0) ? val : -1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	120 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	121
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	122 OPTION
4231 1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	123 NAME = "maximum order"
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	124 DOC_ITEM
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	125 Restrict the maximum order of the solution method. If using the Adams
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	126 method, this option must be between 1 and 12. Otherwise, it must be
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	127 between 1 and 5, inclusive.
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	128
4231 1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	129 END_DOC_ITEM
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4231 diff changeset	130 TYPE = "octave_idx_type"
4231 1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	131 INIT_VALUE = "-1"
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	132 SET_EXPR = "val"
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	133 END_OPTION
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	134
1032fb9ec0d1 [project @ 2002-12-19 19:58:29 by jwe] jwe parents: 4051 diff changeset	135 OPTION
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	136 NAME = "maximum step size"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	137 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	138 Setting the maximum stepsize will avoid passing over very large
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	139 regions (default is not specified).
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	140
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	141 END_DOC_ITEM
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	142 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	143 INIT_VALUE = "-1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	144 SET_EXPR = "(val >= 0.0) ? val : -1.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	145 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	146
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	147 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	148 NAME = "minimum step size"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	149 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	150 The minimum absolute step size allowed (default is 0).
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10350 diff changeset	151
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	152 END_DOC_ITEM
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	153 TYPE = "double"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	154 INIT_VALUE = "0.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	155 SET_EXPR = "(val >= 0.0) ? val : 0.0"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	156 END_OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	157
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	158 OPTION
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	159 NAME = "step limit"
4051 b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	160 DOC_ITEM
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	161 Maximum number of steps allowed (default is 100000).
b79da8779a0e [project @ 2002-08-17 19:38:32 by jwe] jwe parents: 4049 diff changeset	162 END_DOC_ITEM
5275 23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe] jwe parents: 4231 diff changeset	163 TYPE = "octave_idx_type"
3998 f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	164 INIT_VALUE = "100000"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	165 SET_EXPR = "val"
f6df65db67f9 [project @ 2002-07-24 18:10:39 by jwe] jwe parents: diff changeset	166 END_OPTION
31249 de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	167
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	168 OPTION
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	169 NAME = "jacobian type"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	170 DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	171 A string specifying the type of Jacobian used with the stiff backward
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	172 differentiation formula (BDF) integration method. Valid values are
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	173
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	174 @table @asis
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	175 @item @qcode{"full"}
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	176 The default. All partial derivatives are approximated or used from the
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	177 user-supplied Jacobian function.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	178
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	179 @item @qcode{"banded"}
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	180 Only the diagonal and the number of lower and upper subdiagonals specified by
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	181 the options @qcode{"lower jacobian subdiagonals"} and @qcode{"upper jacobian
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	182 subdiagonals"}, respectively, are approximated or used from the user-supplied
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	183 Jacobian function. A user-supplied Jacobian function may set all other
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	184 partial derivatives to arbitrary values.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	185
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	186 @item @qcode{"diagonal"}
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	187 If a Jacobian function is supplied by the user, this setting has no effect.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	188 A Jacobian approximated by @code{lsode} is restricted to the diagonal, where
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	189 each partial derivative is computed by applying a finite change to all
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	190 elements of the state together; if the real Jacobian is indeed always diagonal,
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	191 this has the same effect as applying the finite change only to the respective
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	192 element of the state, but is more efficient.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	193 @end table
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	194
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	195 END_DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	196 TYPE = "std::string"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	197 SET_ARG_TYPE = "const $TYPE&"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	198 INIT_VALUE = ""full""
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	199 SET_BODY
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	200 if (val == "full" \|\| val == "banded" \|\| val == "diagonal")
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	201 $OPTVAR = val;
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	202 else
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	203 (*current_liboctave_error_handler)
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	204 ("lsode_options: jacobian type must be \"full\", \"banded\", or \"diagonal\"");
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	205 END_SET_BODY
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	206 END_OPTION
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	207
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	208 OPTION
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	209 NAME = "lower jacobian subdiagonals"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	210 DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	211 Number of lower subdiagonals used if option @qcode{"jacobian type"} is set to
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	212 @qcode{"banded"}. The default is zero.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	213
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	214 END_DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	215 TYPE = "octave_idx_type"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	216 INIT_VALUE = "0"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	217 SET_EXPR = "val"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	218 END_OPTION
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	219
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	220 OPTION
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	221 NAME = "upper jacobian subdiagonals"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	222 DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	223 Number of upper subdiagonals used if option @qcode{"jacobian type"} is set to
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	224 @qcode{"banded"}. The default is zero.
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	225
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	226 END_DOC_ITEM
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	227 TYPE = "octave_idx_type"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	228 INIT_VALUE = "0"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	229 SET_EXPR = "val"
de6fc38c78c6 Make Jacobian types offered by dlsode.f accessible by lsode (bug #31626). Olaf Till <olaf.till@uni-jena.de> parents: 30564 diff changeset	230 END_OPTION

Mercurial > octave

annotate liboctave/numeric/LSODE-opts.in @ 31249:de6fc38c78c6