Home > freetb4matlab > ocs > TST > TSTbweuler.m

TSTbweuler

PURPOSE ^

%

SYNOPSIS ^

function [out, varargout] = TSTbweuler(outstruct,x,t,tol,maxit,dmp,pltvars,verbosity,dae_fun)

DESCRIPTION ^

% -*- texinfo -*-
%
% @deftypefn{Function File} {[@var{out}, @var{niter}] =}  @
% TSTbweuler(@var{cirstruct}, @var{x},@var{t}, @var{tol},@
%            @var{maxit},@var{dmp}, @var{pltvars},@
%            @var{verbosity} ,@var{dae_fun});
%
% Performs a transient simulation of the system described by
% @var{cirstruct} over the time interval @var{t} using the backward
% Euler algorithm
%
% 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.
%
% The output @var{out} will contain the value of the state vector at
% each  point of @var{t}.
%
% 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
%
% For special purposes one may need to pass modified jacobian and
% residual functions, this can be done
% via the cell array of function handles @var{dae_fun}, such
% functions  should have the same input and output
% parameter list as the default functions
% TSTBWEFUNJAC0,TSTBWEFUNRES0, TSTBWEFUNJAC,TSTBWEFUNRES
%
% The optional output @var{niter} returns the number of Newton iterations
% needed to reach convergence.
% 
% 
% @seealso{TSTdaspk, NLSnewtonraphson, TSTthetamethod}
%
% @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