1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
|
// DO NOT EDIT!
// Generated automatically from ../liboctave/numeric/DASSL-opts.in.
// This file should not include config.h. It is only included in other
// C++ source files that should have included config.h before including
// this file.
#include <iomanip>
#include <ostream>
#include <sstream>
#include "DASSL-opts.h"
#include "defun.h"
#include "pr-output.h"
#include "ovl.h"
#include "utils.h"
#include "pager.h"
static DASSL_options dassl_opts;
#define MAX_TOKENS 4
struct DASSL_options_struct
{
const char *keyword;
const char *kw_tok[MAX_TOKENS + 1];
int min_len[MAX_TOKENS + 1];
int min_toks_to_match;
};
#define NUM_OPTIONS 8
static DASSL_options_struct DASSL_options_table [] =
{
{ "absolute tolerance",
{ "absolute", "tolerance", nullptr, nullptr, nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
{ "relative tolerance",
{ "relative", "tolerance", nullptr, nullptr, nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
{ "compute consistent initial condition",
{ "compute", "consistent", "initial", "condition", nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
{ "enforce nonnegativity constraints",
{ "enforce", "nonnegativity", "constraints", nullptr, nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
{ "initial step size",
{ "initial", "step", "size", nullptr, nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
{ "maximum order",
{ "maximum", "order", nullptr, nullptr, nullptr, },
{ 1, 1, 0, 0, 0, }, 2, },
{ "maximum step size",
{ "maximum", "step", "size", nullptr, nullptr, },
{ 1, 1, 0, 0, 0, }, 2, },
{ "step limit",
{ "step", "limit", nullptr, nullptr, nullptr, },
{ 1, 0, 0, 0, 0, }, 1, },
};
static void
print_DASSL_options (std::ostream& os)
{
std::ostringstream buf;
os << "\n"
<< "Options for DASSL include:\n\n"
<< " keyword value\n"
<< " ------- -----\n";
DASSL_options_struct *list = DASSL_options_table;
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[0].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
Array<double> val = dassl_opts.absolute_tolerance ();
if (val.numel () == 1)
{
os << val(0) << "\n";
}
else
{
os << "\n\n";
Matrix tmp = Matrix (ColumnVector (val));
octave_print_internal (os, tmp, false, 2);
os << "\n\n";
}
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[1].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
Array<double> val = dassl_opts.relative_tolerance ();
if (val.numel () == 1)
{
os << val(0) << "\n";
}
else
{
os << "\n\n";
Matrix tmp = Matrix (ColumnVector (val));
octave_print_internal (os, tmp, false, 2);
os << "\n\n";
}
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[2].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
int val = dassl_opts.compute_consistent_initial_condition ();
os << val << "\n";
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[3].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
int val = dassl_opts.enforce_nonnegativity_constraints ();
os << val << "\n";
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[4].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
double val = dassl_opts.initial_step_size ();
os << val << "\n";
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[5].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
int val = dassl_opts.maximum_order ();
os << val << "\n";
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[6].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
double val = dassl_opts.maximum_step_size ();
os << val << "\n";
}
{
os << " "
<< std::setiosflags (std::ios::left) << std::setw (50)
<< list[7].keyword
<< std::resetiosflags (std::ios::left)
<< " ";
int val = dassl_opts.step_limit ();
os << val << "\n";
}
os << "\n";
}
static void
set_DASSL_options (const std::string& keyword, const octave_value& val)
{
DASSL_options_struct *list = DASSL_options_table;
if (octave::keyword_almost_match (list[0].kw_tok, list[0].min_len,
keyword, list[0].min_toks_to_match, MAX_TOKENS))
{
Array<double> tmp = val.vector_value ();
dassl_opts.set_absolute_tolerance (tmp);
}
else if (octave::keyword_almost_match (list[1].kw_tok, list[1].min_len,
keyword, list[1].min_toks_to_match, MAX_TOKENS))
{
Array<double> tmp = val.vector_value ();
dassl_opts.set_relative_tolerance (tmp);
}
else if (octave::keyword_almost_match (list[2].kw_tok, list[2].min_len,
keyword, list[2].min_toks_to_match, MAX_TOKENS))
{
int tmp = val.int_value ();
dassl_opts.set_compute_consistent_initial_condition (tmp);
}
else if (octave::keyword_almost_match (list[3].kw_tok, list[3].min_len,
keyword, list[3].min_toks_to_match, MAX_TOKENS))
{
int tmp = val.int_value ();
dassl_opts.set_enforce_nonnegativity_constraints (tmp);
}
else if (octave::keyword_almost_match (list[4].kw_tok, list[4].min_len,
keyword, list[4].min_toks_to_match, MAX_TOKENS))
{
double tmp = val.double_value ();
dassl_opts.set_initial_step_size (tmp);
}
else if (octave::keyword_almost_match (list[5].kw_tok, list[5].min_len,
keyword, list[5].min_toks_to_match, MAX_TOKENS))
{
int tmp = val.int_value ();
dassl_opts.set_maximum_order (tmp);
}
else if (octave::keyword_almost_match (list[6].kw_tok, list[6].min_len,
keyword, list[6].min_toks_to_match, MAX_TOKENS))
{
double tmp = val.double_value ();
dassl_opts.set_maximum_step_size (tmp);
}
else if (octave::keyword_almost_match (list[7].kw_tok, list[7].min_len,
keyword, list[7].min_toks_to_match, MAX_TOKENS))
{
int tmp = val.int_value ();
dassl_opts.set_step_limit (tmp);
}
else
{
warning ("dassl_options: no match for `%s'", keyword.c_str ());
}
}
static octave_value_list
show_DASSL_options (const std::string& keyword)
{
octave_value retval;
DASSL_options_struct *list = DASSL_options_table;
if (octave::keyword_almost_match (list[0].kw_tok, list[0].min_len,
keyword, list[0].min_toks_to_match, MAX_TOKENS))
{
Array<double> val = dassl_opts.absolute_tolerance ();
if (val.numel () == 1)
{
retval = val(0);
}
else
{
retval = ColumnVector (val);
}
}
else if (octave::keyword_almost_match (list[1].kw_tok, list[1].min_len,
keyword, list[1].min_toks_to_match, MAX_TOKENS))
{
Array<double> val = dassl_opts.relative_tolerance ();
if (val.numel () == 1)
{
retval = val(0);
}
else
{
retval = ColumnVector (val);
}
}
else if (octave::keyword_almost_match (list[2].kw_tok, list[2].min_len,
keyword, list[2].min_toks_to_match, MAX_TOKENS))
{
int val = dassl_opts.compute_consistent_initial_condition ();
retval = static_cast<double> (val);
}
else if (octave::keyword_almost_match (list[3].kw_tok, list[3].min_len,
keyword, list[3].min_toks_to_match, MAX_TOKENS))
{
int val = dassl_opts.enforce_nonnegativity_constraints ();
retval = static_cast<double> (val);
}
else if (octave::keyword_almost_match (list[4].kw_tok, list[4].min_len,
keyword, list[4].min_toks_to_match, MAX_TOKENS))
{
double val = dassl_opts.initial_step_size ();
retval = val;
}
else if (octave::keyword_almost_match (list[5].kw_tok, list[5].min_len,
keyword, list[5].min_toks_to_match, MAX_TOKENS))
{
int val = dassl_opts.maximum_order ();
retval = static_cast<double> (val);
}
else if (octave::keyword_almost_match (list[6].kw_tok, list[6].min_len,
keyword, list[6].min_toks_to_match, MAX_TOKENS))
{
double val = dassl_opts.maximum_step_size ();
retval = val;
}
else if (octave::keyword_almost_match (list[7].kw_tok, list[7].min_len,
keyword, list[7].min_toks_to_match, MAX_TOKENS))
{
int val = dassl_opts.step_limit ();
retval = static_cast<double> (val);
}
else
{
warning ("dassl_options: no match for `%s'", keyword.c_str ());
}
return retval;
}
DEFUN (dassl_options, args, ,
doc: /* -*- texinfo -*-
@deftypefn {} {} dassl_options ()
@deftypefnx {} {val =} dassl_options (@var{opt})
@deftypefnx {} {} dassl_options (@var{opt}, @var{val})
Query or set options for the function @code{dassl}.
When called with no arguments, the names of all available options and
their current values are displayed.
Given one argument, return the value of the option @var{opt}.
When called with two arguments, @code{dassl_options} sets the option
@var{opt} to value @var{val}.
Options include
@table @asis
@item @qcode{"absolute tolerance"}
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.
@item @qcode{"relative tolerance"}
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
@group
abs (local error in x(i))
<= rtol(i) * abs (Y(i)) + atol(i)
@end group
@end example
@item @qcode{"compute consistent initial condition"}
If nonzero, @code{dassl} will attempt to compute a consistent set of initial
conditions. This is generally not reliable, so it is best to provide
a consistent set and leave this option set to zero.
@item @qcode{"enforce nonnegativity constraints"}
If you know that the solutions to your equations will always be
non-negative, 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.
@item @qcode{"initial step size"}
Differential-algebraic problems may occasionally 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.
@item @qcode{"maximum order"}
Restrict the maximum order of the solution method. This option must
be between 1 and 5, inclusive.
@item @qcode{"maximum step size"}
Setting the maximum stepsize will avoid passing over very large
regions (default is not specified).
@item @qcode{"step limit"}
Maximum number of integration steps to attempt on a single call to the
underlying Fortran code.
@end table
@end deftypefn */)
{
octave_value_list retval;
int nargin = args.length ();
if (nargin > 2)
print_usage ();
if (nargin == 0)
{
print_DASSL_options (octave_stdout);
}
else
{
std::string keyword = args(0).xstring_value ("dassl_options: expecting keyword as first argument");
if (nargin == 1)
retval = show_DASSL_options (keyword);
else
set_DASSL_options (keyword, args(1));
}
return retval;
}
|