Home > freetb4matlab > ocs > TST > TSTodepkg.m

TSTodepkg

PURPOSE ^

%

SYNOPSIS ^

function [out, tout] = TSTodepkg (outstruct, x, t, tol, maxit,

DESCRIPTION ^

% -*- texinfo -*-
%
% @deftypefn{Function File} {[@var{out}, [@var{tout}]] =}  TSTodepkg @
% (@var{cirstruct}, @var{x},@var{t},  @var{tol}, @var{maxit},@
% @var{dmp}, @var{pltvars},@var{solver}, @var{odestruct}, @var{verbosity});
%
% Performs a transient simulation of the system described by
% @var{cirstruct}  over the time interval @var{t} using the odepkg DAE
% solver specified in @var{solver}.
%
% Pssible values for @var{solver} are @code{'ode2r'}, @code{'ode5r'},
% @code{'oders'} or @code{'odesx'}.
%
% An initial value for the state vector is computed by solving
% a steady state problem at @var{t}(1).
% The initial guess for the state vector is set to  @var{x}.   
% @var{tol} @var{maxit} and @var{dmp} are parameters passed
% to NLSnewtonraphson.
%
% If one output is requested @var{out} will contain the value of the state vector
% at each point of @var{t}. 
% If two outputs are requested @var{out} will contain the value of the state vector
% at each point of @var{tout}.
%
% Extra options for options for the solver can be passed to the solver
% via @var{odestruct}.
%
% The optional parameter  @var{verbosity} controls the amount of
% output produced: 
% 
% @itemize @minus 
% @item if verbosity(1) ~= 0, information on the progress
% of the algorithm are output at runtime
% @item if verbosity(2) ~= 0, the plot of the variables whose names
% are listed in @var{pltvars} is
% produced after the computation
% @end itemize
%
% @seealso{TSTbweuler, TSTdaspk, NLSnewtonraphson, odepkg, odeset, @
% ode2r, ode5r, oders, odesx}
%
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003