1 %# Copyright (C) 2006-2012, Thomas Treichl <treichl@users.sourceforge.net>
2 %# OdePkg - A package for solving ordinary differential equations and more
4 %# This program is free software; you can redistribute it and/or modify
5 %# it under the terms of the GNU General Public License as published by
6 %# the Free Software Foundation; either version 2 of the License, or
7 %# (at your option) any later version.
9 %# This program is distributed in the hope that it will be useful,
10 %# but WITHOUT ANY WARRANTY; without even the implied warranty of
11 %# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 %# GNU General Public License for more details.
14 %# You should have received a copy of the GNU General Public License
15 %# along with this program; If not, see <http://www.gnu.org/licenses/>.
18 %# @deftypefn {Function File} {[@var{ret}] =} odeplot (@var{t}, @var{y}, @var{flag})
20 %# Open a new figure window and plot the results from the variable @var{y} of type column vector over time while solving. The types and the values of the input parameter @var{t} and the output parameter @var{ret} depend on the input value @var{flag} that is of type string. If @var{flag} is
22 %# @item @code{"init"}
23 %# then @var{t} must be a double column vector of length 2 with the first and the last time step and nothing is returned from this function,
25 %# then @var{t} must be a double scalar specifying the actual time step and the return value is false (resp. value 0) for 'not stop solving',
26 %# @item @code{"done"}
27 %# then @var{t} must be a double scalar specifying the last time step and nothing is returned from this function.
30 %# This function is called by a OdePkg solver function if it was specified in an OdePkg options structure with the @command{odeset}. This function is an OdePkg internal helper function therefore it should never be necessary that this function is called directly by a user. There is only little error detection implemented in this function file to achieve the highest performance.
32 %# For example, solve an anonymous implementation of the "Van der Pol" equation and display the results while solving
34 %# fvdb = @@(vt,vy) [vy(2); (1 - vy(1)^2) * vy(2) - vy(1)];
36 %# vopt = odeset ('OutputFcn', @@odeplot, 'RelTol', 1e-6);
37 %# vsol = ode45 (fvdb, [0 20], [2 0], vopt);
43 function [varargout] = odeplot (vt, vy, vflag, varargin)
45 %# No input argument check is done for a higher processing speed
46 persistent vfigure; persistent vtold;
47 persistent vyold; persistent vcounter;
49 if (strcmp (vflag, 'init'))
50 %# Nothing to return, vt is either the time slot [tstart tstop]
51 %# or [t0, t1, ..., tn], vy is the inital value vector 'vinit'
52 vfigure = figure; vtold = vt(1,1); vyold = vy(:,1);
55 elseif (isempty (vflag))
56 %# Return something in varargout{1}, either false for 'not stopping
57 %# the integration' or true for 'stopping the integration'
58 vcounter = vcounter + 1; figure (vfigure);
59 vtold(vcounter,1) = vt(1,1);
60 vyold(:,vcounter) = vy(:,1);
61 plot (vtold, vyold, '-o', 'markersize', 1); drawnow;
64 elseif (strcmp (vflag, 'done'))
65 %# Cleanup has to be done, clear the persistent variables because
66 %# we don't need them anymore
67 clear ('vfigure', 'vtold', 'vyold', 'vcounter');
71 %# Local Variables: ***