Operators and Keywords

C++ API

# daspk.cc File Reference

#include <string>
#include <iomanip>
#include <iostream>
#include "DASPK.h"
#include "defun-dld.h"
#include "error.h"
#include "gripes.h"
#include "oct-obj.h"
#include "ov-fcn.h"
#include "ov-cell.h"
#include "pager.h"
#include "unwind-prot.h"
#include "utils.h"
#include "variables.h"
#include "DASPK-opts.cc"
Include dependency graph for daspk.cc: ## Defines

#define DASPK_ABORT()   return retval
#define DASPK_ABORT1(msg)
#define DASPK_ABORT2(fmt, arg)

## Functions

ColumnVector daspk_user_function (const ColumnVector &x, const ColumnVector &xdot, double t, octave_idx_type &ires)
Matrix daspk_user_jacobian (const ColumnVector &x, const ColumnVector &xdot, double t, double cj)
DEFUN_DLD (daspk, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{x}, @var{xdot}, @var{istate}, @var{msg}] =} daspk (@var{fcn}, @var{x_0}, @var{xdot_0}, @var{t}, @var{t_crit})\n\ Solve the set of differential-algebraic equations\n\ @tex\n\ $$0 = f (x, \\dot{x}, t)$$\n\ with\n\ $$x(t_0) = x_0, \\dot{x}(t_0) = \\dot{x}_0$$\n\ @end tex\n\ @ifnottex\n\ \n\ @example\n\ 0 = f (x, xdot, t)\n\ @end example\n\ \n\ @noindent\n\ with\n\ \n\ @example\n\ x(t_0) = x_0, xdot(t_0) = xdot_0\n\ @end example\n\ \n\ @end ifnottex\n\ The solution is returned in the matrices @var{x} and @var{xdot},\n\ with each row in the result matrices corresponding to one of the\n\ elements in the vector @var{t}. The first element of @var{t}\n\ should be @math{t_0} and correspond to the initial state of the\n\ system @var{x_0} and its derivative @var{xdot_0}, so that the first\n\ row of the output @var{x} is @var{x_0} and the first row\n\ of the output @var{xdot} is @var{xdot_0}.\n\ \n\ The first argument, @var{fcn}, is a string, inline, or function handle\n\ that names the function @math{f} to call to compute the vector of\n\ residuals for the set of equations. It must have the form\n\ \n\ @example\n\ @var{res} = f (@var{x}, @var{xdot}, @var{t})\n\ @end example\n\ \n\ @noindent\n\ in which @var{x}, @var{xdot}, and @var{res} are vectors, and @var{t} is a\n\ scalar.\n\ \n\ If @var{fcn} is a two-element string array or a two-element cell array\n\ of strings, inline functions, or function handles, the first element names\n\ the function @math{f} described above, and the second element names a\n\ function to compute the modified Jacobian\n\ @tex\n\ $$\n\ J = {\\partial f \\over \\partial x}\n\ + c {\\partial f \\over \\partial \\dot{x}}\n\$$\n\ @end tex\n\ @ifnottex\n\ \n\ @example\n\ @group\n\ df df\n\ jac = -- + c ------\n\ dx d xdot\n\ @end group\n\ @end example\n\ \n\ @end ifnottex\n\ \n\ The modified Jacobian function must have the form\n\ \n\ @example\n\ @group\n\ \n\ @var{jac} = j (@var{x}, @var{xdot}, @var{t}, @var{c})\n\ \n\ @end group\n\ @end example\n\ \n\ The second and third arguments to @code{daspk} specify the initial\n\ condition of the states and their derivatives, and the fourth argument\n\ specifies a vector of output times at which the solution is desired,\n\ including the time corresponding to the initial condition.\n\ \n\ The set of initial states and derivatives are not strictly required to\n\ be consistent. If they are not consistent, you must use the\n\ @code{daspk_options} function to provide additional information so\n\ that @code{daspk} can compute a consistent starting point.\n\ \n\ The fifth argument is optional, and may be used to specify a set of\n\ times that the DAE solver should not integrate past. It is useful for\n\ avoiding difficulties with singularities and points where there is a\n\ discontinuity in the derivative.\n\ \n\ After a successful computation, the value of @var{istate} will be\n\ greater than zero (consistent with the Fortran version of @sc{daspk}).\n\ \n\ If the computation is not successful, the value of @var{istate} will be\n\ less than zero and @var{msg} will contain additional information.\n\ \n\ You can use the function @code{daspk_options} to set optional\n\ parameters for @code{daspk}.\n\ @seealso{dassl}\n\ @end deftypefn")

## Define Documentation

 #define DASPK_ABORT ( ) return retval
 #define DASPK_ABORT1 ( msg )
Value:
do \
{ \
::error ("daspk: " msg); \
DASPK_ABORT (); \
} \
while (0)

 #define DASPK_ABORT2 ( fmt, arg )
Value:
do \
{ \
::error ("daspk: " fmt, arg); \
DASPK_ABORT (); \
} \
while (0)


## Function Documentation

 ColumnVector daspk_user_function ( const ColumnVector & x, const ColumnVector & xdot, double t, octave_idx_type & ires )
 Matrix daspk_user_jacobian ( const ColumnVector & x, const ColumnVector & xdot, double t, double cj )
 DEFUN_DLD ( daspk , args , nargout )