PDF version (NAG web site
, 64bit version, 64bit version)
NAG Toolbox: nag_ode_ivp_adams_zero_simple (d02cj)
Purpose
nag_ode_ivp_adams_zero_simple (d02cj) integrates a system of firstorder ordinary differential equations over a range with suitable initial conditions, using a variableorder, variablestep Adams' method until a userspecified function, if supplied, of the solution is zero, and returns the solution at points specified by you, if desired.
Syntax
[
x,
y,
ifail] = d02cj(
x,
xend,
y,
fcn,
tol,
relabs,
output,
g, 'n',
n)
[
x,
y,
ifail] = nag_ode_ivp_adams_zero_simple(
x,
xend,
y,
fcn,
tol,
relabs,
output,
g, 'n',
n)
Description
nag_ode_ivp_adams_zero_simple (d02cj) advances the solution of a system of ordinary differential equations
from
$x={\mathbf{x}}$ to
$x={\mathbf{xend}}$ using a variableorder, variablestep Adams' method. The system is defined by
fcn, which evaluates
${f}_{i}$ in terms of
$x$ and
${y}_{1},{y}_{2},\dots ,{y}_{\mathit{n}}$. The initial values of
${y}_{1},{y}_{2},\dots ,{y}_{\mathit{n}}$ must be given at
$x={\mathbf{x}}$.
The solution is returned via
output at points specified by you, if desired: this solution is obtained by
${C}^{1}$ interpolation on solution values produced by the method. As the integration proceeds a check can be made on the userspecified function
$g\left(x,y\right)$ to determine an interval where it changes sign. The position of this sign change is then determined accurately by
${C}^{1}$ interpolation to the solution. It is assumed that
$g\left(x,y\right)$ is a continuous function of the variables, so that a solution of
$g\left(x,y\right)=0.0$ can be determined by searching for a change in sign in
$g\left(x,y\right)$. The accuracy of the integration,
the interpolation and, indirectly, of the determination of the position where
$g\left(x,y\right)=0.0$, is controlled by the arguments
tol and
relabs.
For a description of Adams' methods and their practical implementation see
Hall and Watt (1976).
References
Hall G and Watt J M (ed.) (1976) Modern Numerical Methods for Ordinary Differential Equations Clarendon Press, Oxford
Parameters
Compulsory Input Parameters
 1:
$\mathrm{x}$ – double scalar

The initial value of the independent variable $x$.
Constraint:
${\mathbf{x}}\ne {\mathbf{xend}}$.
 2:
$\mathrm{xend}$ – double scalar

The final value of the independent variable. If ${\mathbf{xend}}<{\mathbf{x}}$, integration will proceed in the negative direction.
Constraint:
${\mathbf{xend}}\ne {\mathbf{x}}$.
 3:
$\mathrm{y}\left({\mathbf{n}}\right)$ – double array

The initial values of the solution ${y}_{1},{y}_{2},\dots ,{y}_{\mathit{n}}$ at $x={\mathbf{x}}$.
 4:
$\mathrm{fcn}$ – function handle or string containing name of mfile

fcn must evaluate the functions
${f}_{i}$ (i.e., the derivatives
${y}_{i}^{\prime}$) for given values of its arguments
$x,{y}_{1},\dots ,{y}_{\mathit{n}}$.
[f] = fcn(x, y)
Input Parameters
 1:
$\mathrm{x}$ – double scalar

$x$, the value of the independent variable.
 2:
$\mathrm{y}\left(\mathit{n}\right)$ – double array

${y}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$, the value of the variable.
Output Parameters
 1:
$\mathrm{f}\left(\mathit{n}\right)$ – double array

The value of
${f}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$.
 5:
$\mathrm{tol}$ – double scalar

A
positive tolerance for controlling the error in the integration. Hence
tol affects the determination of the position where
$g\left(x,y\right)=0.0$, if
$g$ is supplied.
nag_ode_ivp_adams_zero_simple (d02cj) has been designed so that, for most problems, a reduction in
tol leads to an approximately proportional reduction in the error in the solution. However, the actual relation between
tol and the accuracy achieved cannot be guaranteed. You are strongly recommended to call
nag_ode_ivp_adams_zero_simple (d02cj) with more than one value for
tol and to compare the results obtained to estimate their accuracy. In the absence of any prior knowledge, you might compare the results obtained by calling
nag_ode_ivp_adams_zero_simple (d02cj) with
${\mathbf{tol}}={10.0}^{p}$ and
${\mathbf{tol}}={10.0}^{p1}$ where
$p$ correct decimal digits are required in the solution.
Constraint:
${\mathbf{tol}}>0.0$.
 6:
$\mathrm{relabs}$ – string (length ≥ 1)

The type of error control. At each step in the numerical solution an estimate of the local error,
$\mathit{est}$, is made. For the current step to be accepted the following condition must be satisfied:
where
${\tau}_{r}$ and
${\tau}_{a}$ are defined by
where
$\epsilon $ is a small machinedependent number and
${e}_{i}$ is an estimate of the local error at
${y}_{i}$, computed internally. If the appropriate condition is not satisfied, the step size is reduced and the solution is recomputed on the current step. If you wish to measure the error in the computed solution in terms of the number of correct decimal places, then
relabs should be set to 'A' on entry, whereas if the error requirement is in terms of the number of correct significant digits, then
relabs should be set to 'R'. If you prefer a mixed error test, then
relabs should be set to 'M', otherwise if you have no preference,
relabs should be set to the default 'D'. Note that in this case 'D' is taken to be 'M'.
Constraint:
${\mathbf{relabs}}=\text{'M'}$, $\text{'A'}$, $\text{'R'}$ or $\text{'D'}$.
 7:
$\mathrm{output}$ – function handle or string containing name of mfile

output permits access to intermediate values of the computed solution (for example to print or plot them), at successive userspecified points. It is initially called by
nag_ode_ivp_adams_zero_simple (d02cj) with
${\mathbf{xsol}}={\mathbf{x}}$ (the initial value of
$x$). You must reset
xsol to the next point (between the current
xsol and
xend) where
output is to be called, and so on at each call to
output. If, after a call to
output, the reset point
xsol is beyond
xend,
nag_ode_ivp_adams_zero_simple (d02cj) will integrate to
xend with no further calls to
output; if a call to
output is required at the point
${\mathbf{xsol}}={\mathbf{xend}}$, then
xsol must be given precisely the value
xend.
[xsol] = output(xsol, y)
Input Parameters
 1:
$\mathrm{xsol}$ – double scalar

The output value of the independent variable $x$.
 2:
$\mathrm{y}\left(\mathit{n}\right)$ – double array

The computed solution at the point
xsol.
Output Parameters
 1:
$\mathrm{xsol}$ – double scalar

You must set
xsol to the next value of
$x$ at which
output is to be called.
If you do not wish to access intermediate output, the actual argument
output must be the
string
nag_ode_ivp_adams_zero_simple_dummy_output (d02cjx). (
nag_ode_ivp_adams_zero_simple_dummy_output (d02cjx) is included in the NAG Toolbox.)
 8:
$\mathrm{g}$ – function handle or string containing name of mfile

g must evaluate the function
$g\left(x,y\right)$ for specified values
$x,y$. It specifies the function
$g$ for which the first position
$x$ where
$g\left(x,y\right)=0$ is to be found.
[result] = g(x, y)
Input Parameters
 1:
$\mathrm{x}$ – double scalar

$x$, the value of the independent variable.
 2:
$\mathrm{y}\left(\mathit{n}\right)$ – double array

${y}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$, the value of the variable.
Output Parameters
 1:
$\mathrm{result}$ – double scalar

The value of $g\left(x,y\right)$ at the specified point.
If you do not require the rootfinding option, the actual argument
g must be the
string
nag_ode_ivp_adams_zero_simple_dummy_g (d02cjw). (
nag_ode_ivp_adams_zero_simple_dummy_g (d02cjw) is included in the NAG Toolbox.)
Optional Input Parameters
 1:
$\mathrm{n}$ – int64int32nag_int scalar

Default:
the dimension of the array
y.
$\mathit{n}$, the number of differential equations.
Constraint:
${\mathbf{n}}\ge 1$.
Output Parameters
 1:
$\mathrm{x}$ – double scalar

If
$g$ is supplied by you, it contains the point where
$g\left(x,y\right)=0.0$, unless
$g\left(x,y\right)\ne 0.0$ anywhere on the range
x to
xend, in which case,
x will contain
xend. If
$g$ is not supplied by you it contains
xend, unless an error has occurred, when it contains the value of
$x$ at the error.
 2:
$\mathrm{y}\left({\mathbf{n}}\right)$ – double array

The computed values of the solution at the final point $x={\mathbf{x}}$.
 3:
$\mathrm{ifail}$ – int64int32nag_int scalar
${\mathbf{ifail}}={\mathbf{0}}$ unless the function detects an error (see
Error Indicators and Warnings).
Error Indicators and Warnings
Errors or warnings detected by the function:
 ${\mathbf{ifail}}=1$

On entry,  ${\mathbf{tol}}\le 0.0$, 
or  ${\mathbf{n}}\le 0$, 
or  ${\mathbf{relabs}}\ne \text{'M'}$, $\text{'A'}$, $\text{'R'}$ or $\text{'D'}$, 
or  ${\mathbf{x}}={\mathbf{xend}}$. 
 ${\mathbf{ifail}}=2$

With the given value of
tol, no further progress can be made across the integration range from the current point
$x={\mathbf{x}}$. (See
Further Comments for a discussion of this error exit.) The components
${\mathbf{y}}\left(1\right),{\mathbf{y}}\left(2\right),\dots ,{\mathbf{y}}\left({\mathbf{n}}\right)$ contain the computed values of the solution at the current point
$x={\mathbf{x}}$. If you have supplied
$g$, then no point at which
$g\left(x,y\right)$ changes sign has been located up to the point
$x={\mathbf{x}}$.
 ${\mathbf{ifail}}=3$

tol is too small for
nag_ode_ivp_adams_zero_simple (d02cj) to take an initial step.
x and
${\mathbf{y}}\left(1\right),{\mathbf{y}}\left(2\right),\dots ,{\mathbf{y}}\left({\mathbf{n}}\right)$ retain their initial values.
 ${\mathbf{ifail}}=4$

xsol has not been reset or
xsol lies behind
x in the direction of integration, after the initial call to
output, if the
output option was selected.
 ${\mathbf{ifail}}=5$

A value of
xsol returned by the
output has not been reset or lies behind the last value of
xsol in the direction of integration, if the
output option was selected.
 ${\mathbf{ifail}}=6$

At no point in the range
x to
xend did the function
$g\left(x,y\right)$ change sign, if
$g$ was supplied. It is assumed that
$g\left(x,y\right)=0$ has no solution.
 ${\mathbf{ifail}}=7$

A serious error has occurred in an internal call. Check all function calls and array sizes. Seek expert help.
 ${\mathbf{ifail}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
 ${\mathbf{ifail}}=399$
Your licence key may have expired or may not have been installed correctly.
 ${\mathbf{ifail}}=999$
Dynamic memory allocation failed.
Accuracy
The accuracy of the computation of the solution vector
y may be controlled by varying the local error tolerance
tol. In general, a decrease in local error tolerance should lead to an increase in accuracy. You are advised to choose
${\mathbf{relabs}}=\text{'M'}$ unless you have a good reason for a different choice.
If the problem is a rootfinding one, then the accuracy of the root determined will depend on the properties of
$g\left(x,y\right)$. You should try to code
g without introducing any unnecessary cancellation errors.
Further Comments
If more than one root is required then
nag_ode_ivp_adams_roots (d02qf) should be used.
If
nag_ode_ivp_adams_zero_simple (d02cj) fails with
${\mathbf{ifail}}={\mathbf{3}}$, then it can be called again with a larger value of
tol if this has not already been tried. If the accuracy requested is really needed and cannot be obtained with this function,
the system may be very stiff (see below) or so badly scaled that it cannot be solved to the required accuracy.
If
nag_ode_ivp_adams_zero_simple (d02cj) fails with
${\mathbf{ifail}}={\mathbf{2}}$, it is probable that it has been called with a value of
tol which is so small that a solution cannot be obtained on the range
x to
xend. This can happen for wellbehaved systems and very small values of
tol. You should, however, consider whether there is a more fundamental difficulty. For example:
(a) 
in the region of a singularity (infinite value) of the solution, the function
will usually stop with ${\mathbf{ifail}}={\mathbf{2}}$, unless overflow occurs first. Numerical integration cannot be continued through a singularity, and analytic treatment should be considered; 
(b) 
for ‘stiff’ equations where the solution contains rapidly decaying components, the function will use very small steps in $x$ (internally to nag_ode_ivp_adams_zero_simple (d02cj)) to preserve stability. This will exhibit itself by making the computing time excessively long, or occasionally by an exit with ${\mathbf{ifail}}={\mathbf{2}}$. Adams' methods are not efficient in such cases, and you should try nag_ode_ivp_bdf_zero_simple (d02ej). 
Example
This example illustrates the solution of four different problems. In each case the differential system (for a projectile) is
over an interval
${\mathbf{x}}=0.0$ to
${\mathbf{xend}}=10.0$ starting with values
$y=0.5$,
$v=0.5$ and
$\varphi =\pi /5$. We solve each of the following problems with local error tolerances
$\text{1.0e\u22124}$ and
$\text{1.0e\u22125}$.
(i) 
To integrate to $x=10.0$ producing output at intervals of $2.0$ until a point is encountered where $y=0.0$. 
(ii) 
As (i) but with no intermediate output. 
(iii) 
As (i) but with no termination on a rootfinding condition. 
(iv) 
As (i) but with no intermediate output and no rootfinding termination condition. 
Open in the MATLAB editor:
d02cj_example
function d02cj_example
fprintf('d02cj example results\n\n');
global ykeep ncall xkeep;
x = 0;
xend = 10;
y = [0.5; 0.5; pi/5];
tol = 0.0001;
relabs = 'Default';
ncall = 0;
ykeep = zeros(1,length(y));
xkeep = zeros(1,1);
fprintf('Case 1: intermediate output, rootfinding\n\n');
for j = 4:5
tol = double(10)^(j);
disp(['Calculation with tol = ',num2str(tol)]);
disp(' X Y(1) Y(2) Y(3)');
[xOut, yOut, ifail] = d02cj(x, xend, y, @fcn, tol, ...
relabs, @output, @g);
disp(' ');
disp(['Root of Y(1) = 0.0 at ',num2str(xOut)]);
disp('Solution is' );
fprintf(' %8.4f %8.4f %8.4f\n\n', yOut);
end
fprintf('Case 2: no intermediate output, rootfinding\n\n');
for j = 4:5
tol = double(10)^(j);
disp(['Calculation with tol = ',num2str(tol)]);
[xOut, yOut, ifail] = d02cj(x, xend, y, @fcn, tol, ...
relabs, 'd02cjx', @g);
disp(['Root of Y(1) = 0.0 at ',num2str(xOut)]);
disp('Solution is' );
fprintf(' %8.4f %8.4f %8.4f\n\n', yOut);
xOut1 = xOut;
end
fprintf('Case 3: intermediate output, no rootfinding\n\n');
for j = 4:5
tol = double(10)^(j);
disp(['Calculation with tol = ',num2str(tol)]);
disp(' X Y(1) Y(2) Y(3)');
[xOut, yOut, ifail] = d02cj(x, xend, y, @fcn, tol, ...
relabs, @save, 'd02cjw');
fprintf('\n');
end
fprintf(['Case 4: no intermediate output, no rootfinding ', ...
'(integrate to xend)\n\n']);
for j = 4:5
tol = double(10)^(j);
disp(['Calculation with tol = ',num2str(tol)]);
disp(' X Y(1) Y(2) Y(3)');
fprintf('%2d %8.4f %8.4f %8.4f\n', x, y);
[xOut, yOut, ifail] = d02cj(x, xend, y, @fcn, tol, ...
relabs, 'd02cjx','d02cjw');
fprintf('\n');
end
nres = 0.5*length(xkeep);
xplot = xkeep(nres+1:2*nres);
yplot = ykeep(nres+1:2*nres, :);
fig1 = figure;
display_plot(xplot, yplot, xOut1)
function xsolOut = save(xsol, y)
global ykeep ncall xkeep;
ncall = ncall+1;
ykeep(ncall,:) = y;
xkeep(ncall,:) = xsol;
fprintf('%2d %8.4f %8.4f %8.4f\n', xsol, y);
xsolOut = xsol + 2;
function xsolOut = output(xsol, y)
fprintf('%2d %8.4f %8.4f %8.4f\n', xsol, y);
xsolOut = xsol + 2;
function f = fcn(x,y)
f = zeros(3,1);
f(1) = tan(y(3));
f(2) = 0.032*tan(y(3))/y(2)  0.02*y(2)/cos(y(3));
f(3) = 0.032/y(2)^2;
function result = g(x,y)
result = y(1);
function display_plot(xplot, yplot, xOut1)
plot(xplot, yplot(:,1), '+', ...
xplot, yplot(:,2), 'x', ...
xplot, yplot(:,3), ':*');
do_stem(xplot, yplot, xOut1);
title('ODE Solution using Adams Method with Rootfinding');
xlabel('x');
ylabel('Solution');
legend('height','velocity','angle','height = 0','Location','Best');
function do_stem(xplot, yplot, xOut1)
for i = 1:length(xplot)
if xplot(i) > xOut1
break
end
end
dx = xplot(i)xplot(i1);
ddx = xOut1xplot(i1);
d1 = ddx/dx;
f1 = yplot(i1,2) + d1*(yplot(i,2)yplot(i1,2));
f2 = yplot(i1,3) + d1*(yplot(i,3)yplot(i1,3));
hold on
stem([xOut1,xOut1],[f1,0],'k:s');
hold on
stem([xOut1,xOut1],[f2,0],'k:s');
d02cj example results
Case 1: intermediate output, rootfinding
Calculation with tol = 0.0001
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
2 1.5493 0.4055 0.3066
4 1.7423 0.3743 0.1289
6 1.0055 0.4173 0.5507
Root of Y(1) = 0.0 at 7.2883
Solution is
0.0000 0.4749 0.7601
Calculation with tol = 1e05
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
2 1.5493 0.4055 0.3066
4 1.7423 0.3743 0.1289
6 1.0055 0.4173 0.5507
Root of Y(1) = 0.0 at 7.2882
Solution is
0.0000 0.4749 0.7601
Case 2: no intermediate output, rootfinding
Calculation with tol = 0.0001
Root of Y(1) = 0.0 at 7.2883
Solution is
0.0000 0.4749 0.7601
Calculation with tol = 1e05
Root of Y(1) = 0.0 at 7.2882
Solution is
0.0000 0.4749 0.7601
Case 3: intermediate output, no rootfinding
Calculation with tol = 0.0001
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
2 1.5493 0.4055 0.3066
4 1.7423 0.3743 0.1289
6 1.0055 0.4173 0.5507
8 0.7459 0.5130 0.8537
10 3.6281 0.6333 1.0515
Calculation with tol = 1e05
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
2 1.5493 0.4055 0.3066
4 1.7423 0.3743 0.1289
6 1.0055 0.4173 0.5507
8 0.7460 0.5130 0.8537
10 3.6283 0.6333 1.0515
Case 4: no intermediate output, no rootfinding (integrate to xend)
Calculation with tol = 0.0001
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
Calculation with tol = 1e05
X Y(1) Y(2) Y(3)
0 0.5000 0.5000 0.6283
PDF version (NAG web site
, 64bit version, 64bit version)
© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015