NAG Toolbox: nag_ode_sl2_reg_finite (d02ka)

Purpose

Syntax

Description

References

Parameters

Compulsory Input Parameters

1:     $\mathrm{xl}$ – double scalar

2:     $\mathrm{xr}$ – double scalar

The left- and right-hand end points $a$ and $b$ respectively, of the interval of definition of the problem.

Constraint: $\mathbf{xl}<\mathbf{xr}$.

3:     $\mathrm{coeffn}$ – function handle or string containing name of m-file

coeffn must compute the values of the coefficient functions $p\left(x\right)$ and $q\left(x;\lambda \right)$ for given values of $x$ and $\lambda$. Description states the conditions which $p$ and $q$ must satisfy.

[p, q, dqdl] = coeffn(x, elam, jint)

Input Parameters

1:     $\mathrm{x}$ – double scalar

The current value of $x$.

2:     $\mathrm{elam}$ – double scalar

The current trial value of the eigenvalue argument $\lambda$.

3:     $\mathrm{jint}$ – int64int32nag_int scalar

This argument is included for compatibility with the more complex function nag_ode_sl2_breaks_vals (d02kd) (which is called by nag_ode_sl2_reg_finite (d02ka)).

Need not be set.

Output Parameters

1:     $\mathrm{p}$ – double scalar

The value of $p\left(x\right)$ for the current value of $x$.

2:     $\mathrm{q}$ – double scalar

The value of $q\left(x;\lambda \right)$ for the current value of $x$ and the current trial value of $\lambda$.

3:     $\mathrm{dqdl}$ – double scalar

The value of $\frac{\partial q}{\partial \lambda }\left(x;\lambda \right)$ for the current value of $x$ and the current trial value of $\lambda$. However dqdl is only used in error estimation and, in the rare cases where it may be difficult to evaluate, an approximation (say to within $20\%$) will suffice.

4:     $\mathrm{bcond}\left(3,2\right)$ – double array

$\mathbf{bcond}\left(1,1\right)$ and $\mathbf{bcond}\left(2,1\right)$ must contain the numbers $a_1$, $a_2$ specifying the left-hand boundary condition in the form

$$a_{2}y\left(a\right)=a_{1}p\left(a\right)y^{\prime }\left(a\right)$$

where $\left|a_2\right|+\left|a_{1}p\left(a\right)\right|\ne 0$.

$\mathbf{bcond}\left(1,2\right)$ and $\mathbf{bcond}\left(2,2\right)$ must contain $b_1$, $b_2$ such that

$$b_{2}y\left(b\right)=b_{1}p\left(b\right)y^{\prime }\left(b\right)$$

where $\left|b_2\right|+\left|b_{1}p\left(b\right)\right|\ne 0$.

Note the occurrence of $p\left(a\right)$, $p\left(b\right)$ in these formulae.

5:     $\mathrm{k}$ – int64int32nag_int scalar

$k$, the index of the required eigenvalue when the eigenvalues are ordered

$${\lambda }_0<{\lambda }_1<{\lambda }_2<\cdots <{\lambda }_k<\cdots \text{.}$$

Constraint: $\mathbf{k}\ge 0$.

6:     $\mathrm{tol}$ – double scalar

The tolerance argument which determines the accuracy of the computed eigenvalue. The error estimate held in delam on exit satisfies the mixed absolute/relative error test

$$\mathbf{delam}\le \mathbf{tol}\times \max \left(1.0,\left|\mathbf{elam}\right|\right)\text{,}$$

(1)

where elam is the final estimate of the eigenvalue. delam is usually somewhat smaller than the right-hand side of (1) but not several orders of magnitude smaller.

Constraint: $\mathbf{tol}>0.0$.

7:     $\mathrm{elam}$ – double scalar

An initial estimate of the eigenvalue $\tilde{\lambda }$.

8:     $\mathrm{delam}$ – double scalar

An indication of the scale of the problem in the $\lambda$-direction. delam holds the initial ‘search step’ (positive or negative). Its value is not critical, but the first two trial evaluations are made at elam and $\mathbf{elam}+\mathbf{delam}$, so the function will work most efficiently if the eigenvalue lies between these values. A reasonable choice (if a closer bound is not known) is about half the distance between adjacent eigenvalues in the neighbourhood of the one sought. In practice, there will often be a problem, similar to the one in hand but with known eigenvalues, which will help one to choose initial values for elam and delam.

If $\mathbf{delam}=0.0$ on entry, it is given the default value of $0.25\times \max \left(1.0,\left|\mathbf{elam}\right|\right)$.

9:     $\mathrm{monit}$ – function handle or string containing name of m-file

monit is called by nag_ode_sl2_reg_finite (d02ka) at the end of each iteration for $\lambda$ and allows you to monitor the course of the computation by printing out the arguments (see Example for an example).

If no monitoring is required, the dummy (sub)program nag_ode_sl2_reg_finite_dummy_monit (d02kay) may be used. (nag_ode_sl2_reg_finite_dummy_monit (d02kay) is included in the NAG Toolbox.)

monit(nit, iflag, elam, finfo)

Input Parameters

1:     $\mathrm{nit}$ – int64int32nag_int scalar

15 minus the number of iterations used so far in the search for $\tilde{\lambda }$. (Up to $15$ iterations are permitted.)

2:     $\mathrm{iflag}$ – int64int32nag_int scalar

Describes what phase the computation is in.

$\mathbf{iflag}<0$

An error occurred in the computation at this iteration; an error exit from nag_ode_sl2_reg_finite (d02ka) will follow.

$\mathbf{iflag}=1$

The function is trying to bracket the eigenvalue $\tilde{\lambda }$.

$\mathbf{iflag}=2$

The function is converging to the eigenvalue $\tilde{\lambda }$ (having already bracketed it).

Normally, the iteration will terminate after a sequence of iterates with $\mathbf{iflag}=2$, but occasionally the bracket on $\tilde{\lambda }$ thus determined will not be sufficiently small and the iteration will be repeated with tighter accuracy control.

3:     $\mathrm{elam}$ – double scalar

The current trial value of $\tilde{\lambda }$.

4:     $\mathrm{finfo}\left(15\right)$ – double array

Information about the behaviour of the shooting method, and diagnostic information in the case of errors. It should not normally be printed in full if no error has occurred (that is, if $\mathbf{iflag}\ge 0$), though the first few components may be of interest to you. In case of an error ($\mathbf{iflag}<0$) all the components of finfo should be printed.

The contents of finfo are as follows:

$\mathbf{finfo}\left(1\right)$

The current value of the ‘miss-distance’ or ‘residual’ function $f\left(\lambda \right)$ on which the shooting method is based. $f\left(\tilde{\lambda }\right)=0$ in theory. This is set to zero if $\mathbf{iflag}<0$.

$\mathbf{finfo}\left(2\right)$

An estimate of the quantity $\partial \lambda$ defined as follows. Consider the perturbation in the miss-distance $f\left(\lambda \right)$ that would result if the local error in the solution of the differential equation were always positive and equal to its maximum permitted value. Then $\partial \lambda$ is the perturbation in $\lambda$ that would have the same effect on $f\left(\lambda \right)$. Thus, at the zero of $f\left(\lambda \right),\left|\partial \lambda \right|$ is an approximate bound on the perturbation of the zero (that is the eigenvalue) caused by errors in numerical solution. If $\partial \lambda$ is very large then it is possible that there has been a programming error in coeffn such that $q$ is independent of $\lambda$. If this is the case, an error exit with $\mathbf{ifail}=\mathbf{5}$ should follow. $\mathbf{finfo}\left(2\right)$ is set to zero if $\mathbf{iflag}<0$.

$\mathbf{finfo}\left(3\right)$

The number of internal iterations, using the same value of $\lambda$ and tighter accuracy tolerances, needed to bring the accuracy (that is, the value of $\partial \lambda$) to an acceptable value. Its value should normally be $1.0$, and should almost never exceed $2.0$.

$\mathbf{finfo}\left(4\right)$

The number of calls to coeffn at this iteration.

$\mathbf{finfo}\left(5\right)$

The number of successful steps taken by the internal differential equation solver at this iteration. A step is successful if it is used to advance the integration.

$\mathbf{finfo}\left(6\right)$

The number of unsuccessful steps used by the internal integrator at this iteration.

$\mathbf{finfo}\left(7\right)$

The number of successful steps at the maximum step size taken by the internal integrator at this iteration.

$\mathbf{finfo}\left(8\right)$

Not used.

$\mathbf{finfo}\left(9\right)$ to $\mathbf{finfo}\left(15\right)$

Set to zero, unless $\mathbf{iflag}<0$ in which case they hold the following values describing the point of failure:

$\mathbf{finfo}\left(9\right)$

1 or $2$ depending on whether integration was in a forward or backward direction at the time of failure.

$\mathbf{finfo}\left(10\right)$

The value of the independent variable, $x$, the point at which the error occurred.

$\mathbf{finfo}\left(11\right)$, $\mathbf{finfo}\left(12\right)$, $\mathbf{finfo}\left(13\right)$

The current values of the Pruefer dependent variables $\beta$, $\varphi$ and $\rho$ respectively. See Description in nag_ode_sl2_breaks_funs (d02ke) for a description of these variables.

$\mathbf{finfo}\left(14\right)$

The local-error tolerance being used by the internal integrator at the point of failure.

$\mathbf{finfo}\left(15\right)$

The last integration mesh point.

Optional Input Parameters

None.

Output Parameters

1:     $\mathrm{bcond}\left(3,2\right)$ – double array

$\mathbf{bcond}\left(3,1\right)$ and $\mathbf{bcond}\left(3,2\right)$ hold values ${\sigma }_l,{\sigma }_r$ estimating the sensitivity of the computed eigenvalue to changes in the boundary conditions. These values should only be of interest if the boundary conditions are, in some sense, an approximation to some ‘true’ boundary conditions. For example, if the range [xl, xr] should really be $\left[0,\infty \right]$ but instead xr has been given a large value and the boundary conditions at infinity applied at xr, then the sensitivity argument ${\sigma }_r$ may be of interest. Refer to Examples of Boundary Conditions at Singular Points in nag_ode_sl2_breaks_vals (d02kd), for the actual meaning of ${\sigma }_r$ and ${\sigma }_l$.

2:     $\mathrm{elam}$ – double scalar

The final computed estimate, whether or not an error occurred.

3:     $\mathrm{delam}$ – double scalar

If $\mathbf{ifail}=\mathbf{0}$, delam holds an estimate of the absolute error in the computed eigenvalue, that is $\left|\tilde{\lambda }-\mathbf{elam}\right|\simeq \mathbf{delam}$, where $\tilde{\lambda }$ is the true eigenvalue.

If $\mathbf{ifail}\ne \mathbf{0}$, delam may hold an estimate of the error, or its initial value, depending on the value of ifail. See Error Indicators and Warnings for further details.

4:     $\mathrm{ifail}$ – int64int32nag_int scalar

$\mathbf{ifail}=\mathbf{0}$ unless the function detects an error (see Error Indicators and Warnings).

Error Indicators and Warnings

Cases prefixed with W are classified as warnings and do not generate an error of type NAG:error_n. See nag_issue_warnings.

   $\mathbf{ifail}=1$

On entry,	$\mathbf{k}<0$,
or	$\mathbf{tol}\le 0.0$.

   $\mathbf{ifail}=2$

On entry,	$a_1=p\left(a\right)a_2=0$,
or	$b_1=p\left(b\right)b_2=0$,

(the array bcond has been set up incorrectly).

   $\mathbf{ifail}=3$

At some point between xl and xr the value of $p\left(x\right)$ computed by coeffn became zero or changed sign. See the last call of monit for details.

   $\mathbf{ifail}=4$

After $15$ iterations the eigenvalue had not been found to the required accuracy.

   $\mathbf{ifail}=5$

The ‘bracketing’ phase (with iflag of the monit equal to $1$) failed to bracket the eigenvalue within ten iterations. This is caused by an error in formulating the problem (for example, $q$ is independent of $\lambda$), or by very poor initial estimates of elam and delam.

On exit, elam and $\mathbf{elam}+\mathbf{delam}$ give the end points of the interval within which no eigenvalue was located by the function.

   $\mathbf{ifail}=6$

To obtain the desired accuracy the local error tolerance was set so small at the start of some sub-interval that the differential equation solver could not choose an initial step size large enough to make significant progress. See the last call of monit for diagnostics.

   $\mathbf{ifail}=7$

At some point the step size in the differential equation solver was reduced to a value too small to make significant progress (for the same reasons as with $\mathbf{ifail}=\mathbf{6}$). This could be due to pathological behaviour of $p\left(x\right)$ and $q\left(x;\lambda \right)$ or to an unreasonable accuracy requirement or to the current value of $\lambda$ making the equations ‘stiff’. See the last call of monit for details.

W  $\mathbf{ifail}=8$

tol is too small for the problem being solved and the machine precision being used. The local value of elam should be a very good approximation to the eigenvalue $\tilde{\lambda }$.

   $\mathbf{ifail}=9$

nag_roots_contfn_brent_rcomm (c05az), called by nag_ode_sl2_reg_finite (d02ka), has terminated with the error exit corresponding to a pole of the matching function. This error exit should not occur, but if it does, try solving the problem again with a smaller value for tol.

   $\mathbf{ifail}=10$

   $\mathbf{ifail}=11$

   $\mathbf{ifail}=12$

A serious error has occurred in an internal call to an interpolation function. Check all (sub)program calls and array dimensions. 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

Further Comments

Example

Open in the MATLAB editor: d02ka_example

function d02ka_example


fprintf('d02ka example results\n\n');

xl = 0;
xr = pi;
bcond = [1, 1;
         0, 0;
         0, 0];
k = int64(4);
elam_in = 15;
delam_in = 4;

for tol_ind=-5:-1:-6
  tol = 10^tol_ind;

  [bcond, elam, delam, ifail] = ...
    d02ka(...
           xl, xr, @coeffn, bcond, k, tol, elam_in, delam_in, @monit);

  fprintf('\nCalculation with tol = %12.4e\n\n',tol);
  fprintf('Final results\n\n');
  fprintf('K = %3d  elam = %7.3f  delam = %8.2e\n', k, elam, delam);
  fprintf('Boundary sensitivities, left: %12.4e, right: %12.4e\n',...
          bcond(3,1:2))
end



function [p, q, dqdl] = coeffn(x, elam, jint)
  p = 1;
  dqdl = 1;
  q = elam - 10*cos(2*x);

function monit(nit, iflag, elam, finfo)
  if (nit == 14)
    fprintf('\nOutput from Monit\n');
  end
  fprintf('%2d   %d   %6.3f %+6.3f %+6.3g %+6.3f %+6.3f\n', ...
          nit, iflag, elam, finfo(1:4));

d02ka example results


Output from Monit
14   1   15.000 -0.322 -0.000108 +1.000 +206.000
13   1   15.000 -0.322 -5.67e-05 +2.000 +234.000
12   1   19.000 +0.257 -6.69e-05 +1.000 +226.000
11   2   17.225 +0.018 -6.75e-05 +1.000 +226.000
10   2   17.097 +0.000 -6.43e-05 +1.000 +226.000
 9   2   17.097 -0.000 -6.41e-05 +1.000 +226.000
 8   2   17.097 -0.000 -6.41e-05 +1.000 +226.000

Calculation with tol =   1.0000e-05

Final results

K =   4  elam =  17.097  delam = 1.50e-04
Boundary sensitivities, left:  -9.0635e-01, right:   9.0635e-01

Output from Monit
14   1   15.000 -0.322 -0.000108 +1.000 +206.000
13   1   15.000 -0.322 -5.64e-06 +2.000 +410.000
12   1   19.000 +0.257 -6.75e-06 +1.000 +406.000
11   2   17.225 +0.018 -6.75e-06 +1.000 +394.000
10   2   17.097 +0.000 -6.43e-06 +1.000 +394.000
 9   2   17.097 +0.000 -6.41e-06 +1.000 +394.000
 8   2   17.097 -0.000 -6.41e-06 +1.000 +394.000
 7   2   17.097 +0.000 -6.41e-06 +1.000 +394.000

Calculation with tol =   1.0000e-06

Final results

K =   4  elam =  17.097  delam = 1.50e-05
Boundary sensitivities, left:  -9.0753e-01, right:   9.0753e-01