Operators and Keywords

Function List:

C++ API File Reference

#include <iomanip>
#include <iostream>
#include "LSODE-opts.h"
#include "defun-dld.h"
#include "pr-output.h"
#include "oct-obj.h"
#include "utils.h"
#include "pager.h"

Include dependency graph for

This graph shows which files directly or indirectly include this file:


struct  LSODE_options_struct


#define MAX_TOKENS   3
#define NUM_OPTIONS   8


 DEFUN_DLD (lsode_options, args,,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {} lsode_options (@var{opt}, @var{val})\n\ When called with two arguments, this function\n\ allows you set options parameters for the function @code{lsode}.\n\ Given one argument, @code{lsode_options} returns the value of the\n\ corresponding option. If no arguments are supplied, the names of all\n\ the available options and their current values are displayed.\n\ \n\ Options include\n\ \n\ @table @code\n\ @item \"absolute tolerance\"\n\ Absolute tolerance. May be either vector or scalar. If a vector, it\n\ must match the dimension of the state vector.\n\ @item \"relative tolerance\"\n\ Relative tolerance parameter. Unlike the absolute tolerance, this\n\ parameter may only be a scalar.\n\ \n\ The local error test applied at each integration step is\n\ \n\ @example\n\ @group\n\ abs (local error in x(i)) <= ...\n\ rtol * abs (y(i)) + atol(i)\n\ @end group\n\ @end example\n\ @item \"integration method\"\n\ A string specifying the method of integration to use to solve the ODE\n\ system. Valid values are\n\ \n\ @table @asis\n\ @item \"adams\"\n\ @itemx \"non-stiff\"\n\ No Jacobian used (even if it is available).\n\ @item \"bdf\"\n\ @item \"stiff\"\n\ Use stiff backward differentiation formula (BDF) method. If a\n\ function to compute the Jacobian is not supplied, @code{lsode} will\n\ compute a finite difference approximation of the Jacobian matrix.\n\ @end table\n\ @item \"initial step size\"\n\ The step size to be attempted on the first step (default is determined\n\ automatically).\n\ @item \"maximum order\"\n\ Restrict the maximum order of the solution method. If using the Adams\n\ method, this option must be between 1 and 12. Otherwise, it must be\n\ between 1 and 5, inclusive.\n\ @item \"maximum step size\"\n\ Setting the maximum stepsize will avoid passing over very large\n\ regions (default is not specified).\n\ @item \"minimum step size\"\n\ The minimum absolute step size allowed (default is 0).\n\ @item \"step limit\"\n\ Maximum number of steps allowed (default is 100000).\n\ @end table\n\ @end deftypefn")

Define Documentation

#define MAX_TOKENS   3

#define NUM_OPTIONS   8

Function Documentation

DEFUN_DLD ( lsode_options  ,