NAG Library Routine Document

D02KDF

1  Purpose

2  Specification

3  Description

4  References

5  Parameters

1:     $\mathrm{XPOINT}\left(\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the points where the boundary conditions computed by BDYVAL are to be imposed, and also any break-points, i.e., $\mathbf{XPOINT}\left(1\right)$ to $\mathbf{XPOINT}\left(m\right)$ must contain values $x_1,\dots ,x_m$ such that

$$x_1\le x_2<x_3<\cdots <x_{m-1}\le x_m$$

with the following meanings:

(a)	$x_1$ and $x_m$ are the left- and right-hand end points, $a$ and $b$, of the domain of definition of the Sturm–Liouville system if these are finite. If either $a$ or $b$ is infinite, the corresponding value $x_1$ or $x_m$ may be a more-or-less arbitrarily ‘large’ number of appropriate sign.
(b)	$x_2$ and $x_{m-1}$ are the Boundary Matching Points (BMPs), that is the points at which the left and right boundary conditions computed in BDYVAL are imposed. If the left-hand end point is a regular point then you should set $x_2=x_1$ $\left(=a\right)$, while if it is a singular point you must set $x_2>x_1$. Similarly $x_{m-1}=x_m$ ($=b$) if the right-hand end point is regular, and $x_{m-1}<x_m$ if it is singular.
(c)	The remaining $m-4$ points $x_3,\dots ,x_{m-2}$, if any, define ‘break-points’ which divide the interval $\left[x_2,x_{m-1}\right]$ into $m-3$ sub-intervals $$i_1=\left[x_2,x_3\right],\dots ,i_{m-3}=\left[x_{m-2},x_{m-1}\right]\text{.}$$   Numerical integration of the differential equation is stopped and restarted at each break-point. In simple cases no break-points are needed. However, if $p\left(x\right)$ or $q\left(x;\lambda \right)$ are given by different formulae in different parts of the interval, then integration is more efficient if the range is broken up by break-points in the appropriate way. Similarly points where any jumps occur in $p\left(x\right)$ or $q\left(x;\lambda \right)$, or in their derivatives up to the fifth-order, should appear as break-points. Examples are given in Sections 9 and 10. XPOINT determines the position of the Shooting Matching Point (SMP), as explained in Section 9.3.

Constraint: $\mathbf{XPOINT}\left(1\right)\le \mathbf{XPOINT}\left(2\right)<\cdots <\mathbf{XPOINT}\left(\mathbf{M}-1\right)\le \mathbf{XPOINT}\left(\mathbf{M}\right)$.

2:     $\mathrm{M}$ – INTEGERInput

On entry: the number of points in the array XPOINT.

Constraint: $\mathbf{M}\ge 4$.

3:     $\mathrm{COEFFN}$ – SUBROUTINE, supplied by the user.External Procedure

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$. Section 3 states the conditions which $p$ and $q$ must satisfy. See Sections 9.4 and 10 for examples.

The specification of COEFFN is:

SUBROUTINE COEFFN ( P, Q, DQDL, X, ELAM, JINT) INTEGER  JINT REAL (KIND=nag_wp)  P, Q, DQDL, X, ELAM

1:     $\mathrm{P}$ – REAL (KIND=nag_wp)Output

On exit: the value of $p\left(x\right)$ for the current value of $x$.

2:     $\mathrm{Q}$ – REAL (KIND=nag_wp)Output

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

3:     $\mathrm{DQDL}$ – REAL (KIND=nag_wp)Output

On exit: 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{X}$ – REAL (KIND=nag_wp)Input

On entry: the current value of $x$.

5:     $\mathrm{ELAM}$ – REAL (KIND=nag_wp)Input

On entry: the current trial value of the eigenvalue parameter $\lambda$.

6:     $\mathrm{JINT}$ – INTEGERInput

On entry: the index $j$ of the sub-interval $i_j$ (see specification of XPOINT) in which $x$ lies.

COEFFN must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02KDF is called. Parameters denoted as Input must not be changed by this procedure.

4:     $\mathrm{BDYVAL}$ – SUBROUTINE, supplied by the user.External Procedure

BDYVAL must define the boundary conditions. For each end point, BDYVAL must return (in YL or YR) values of $y\left(x\right)$ and $p\left(x\right)y^{\prime }\left(x\right)$ which are consistent with the boundary conditions at the end points; only the ratio of the values matters. Here $x$ is a given point (XL or XR) equal to, or close to, the end point.

For a regular end point ($a$, say), $x=a$, a boundary condition of the form

$$c_{1}y\left(a\right)+c_2{y}^{\prime }\left(a\right)=0$$

can be handled by returning constant values in YL, e.g., $\mathbf{YL}\left(1\right)=c_2$ and $\mathbf{YL}\left(2\right)=-c_{1}p\left(a\right)$.

For a singular end point however, $\mathbf{YL}\left(1\right)$ and $\mathbf{YL}\left(2\right)$ will in general be functions of XL and ELAM, and $\mathbf{YR}\left(1\right)$ and $\mathbf{YR}\left(2\right)$ functions of XR and ELAM, usually derived analytically from a power-series or asymptotic expansion. Examples are given in Sections 9.5 and 10.

The specification of BDYVAL is:

SUBROUTINE BDYVAL ( XL, XR, ELAM, YL, YR) REAL (KIND=nag_wp)  XL, XR, ELAM, YL(3), YR(3)

1:     $\mathrm{XL}$ – REAL (KIND=nag_wp)Input

On entry: if $a$ is a regular end point of the system (so that $a=x_1=x_2$), then XL contains $a$. If $a$ is a singular point (so that $a\le x_1<x_2$), then XL contains a point $x$ such that $x_1<x\le x_2$.

2:     $\mathrm{XR}$ – REAL (KIND=nag_wp)Input

On entry: if $b$ is a regular end point of the system (so that $x_{m-1}=x_m=b$), then XR contains $b$. If $b$ is a singular point (so that $x_{m-1}<x_m\le b$), then XR contains a point $x$ such that $x_{m-1}\le x<x_m$.

3:     $\mathrm{ELAM}$ – REAL (KIND=nag_wp)Input

On entry: the current trial value of $\lambda$.

4:     $\mathrm{YL}\left(3\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: $\mathbf{YL}\left(1\right)$ and $\mathbf{YL}\left(2\right)$ should contain values of $y\left(x\right)$ and $p\left(x\right)y^{\prime }\left(x\right)$ respectively (not both zero) which are consistent with the boundary condition at the left-hand end point, given by $x=\mathbf{XL}$. $\mathbf{YL}\left(3\right)$ should not be set.

5:     $\mathrm{YR}\left(3\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: $\mathbf{YR}\left(1\right)$ and $\mathbf{YR}\left(2\right)$ should contain values of $y\left(x\right)$ and $p\left(x\right)y^{\prime }\left(x\right)$ respectively (not both zero) which are consistent with the boundary condition at the right-hand end point, given by $x=\mathbf{XR}$. $\mathbf{YR}\left(3\right)$ should not be set.

BDYVAL must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02KDF is called. Parameters denoted as Input must not be changed by this procedure.

5:     $\mathrm{K}$ – INTEGERInput

On entry: $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}$ – REAL (KIND=nag_wp)Input

On entry: the tolerance parameter 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}$ – REAL (KIND=nag_wp)Input/Output

On entry: an initial estimate of the eigenvalue $\tilde{\lambda }$.

On exit: the final computed estimate, whether or not an error occurred.

8:     $\mathrm{DELAM}$ – REAL (KIND=nag_wp)Input/Output

On entry: 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 routine will work most efficiently if the eigenvalue lies between these values. A reasonable choice (if a closer bound is not known) is 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)$.

On exit: 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}$. (In Section 9.2 we discuss the assumptions under which this is true.) The true error is rarely more than twice, or less than a tenth, of the estimated error.

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 Section 6 for further details.

9:     $\mathrm{HMAX}\left(2,\mathbf{M}\right)$ – REAL (KIND=nag_wp) arrayInput/Output

On entry: $\mathbf{HMAX}\left(1,\mathit{j}\right)$ should contain a maximum step size to be used by the differential equation code in the $\mathit{j}$th sub-interval ${\mathit{i}}_{\mathit{j}}$ (as described in the specification of parameter XPOINT), for $\mathit{j}=1,2,\dots ,m-3$. If it is zero the routine generates a maximum step size internally.

It is recommended that $\mathbf{HMAX}\left(1,j\right)$ be set to zero unless the coefficient functions $p$ and $q$ have features (such as a narrow peak) within the $j$th sub-interval that could be ‘missed’ if a long step were taken. In such a case $\mathbf{HMAX}\left(1,j\right)$ should be set to about half the distance over which the feature should be observed. Too small a value will increase the computing time for the routine. See Section 9 for further suggestions.

The rest of the array is used as workspace.

On exit: $\mathbf{HMAX}\left(1,m-1\right)$ and $\mathbf{HMAX}\left(1,m\right)$ contain the sensitivity coefficients ${\sigma }_l,{\sigma }_r$, described in Section 9.6. Other entries contain diagnostic output in the case of an error exit (see Section 6).

10:   $\mathrm{MAXIT}$ – INTEGERInput/Output

On entry: a bound on $n_r$, the number of root-finding iterations allowed, that is the number of trial values of $\lambda$ that are used. If $\mathbf{MAXIT}\le 0$, no such bound is assumed. (See also MAXFUN.)

Suggested value: $\mathbf{MAXIT}=0$.

On exit: will have been decreased by the number of iterations actually performed, whether or not it was positive on entry.

11:   $\mathrm{MAXFUN}$ – INTEGERInput

On entry: a bound on $n_f$, the number of calls to COEFFN made in any one root-finding iteration. If $\mathbf{MAXFUN}\le 0$, no such bound is assumed.

Suggested value: $\mathbf{MAXFUN}=0$.

MAXFUN and MAXIT may be used to limit the computational cost of a call to D02KDF, which is roughly proportional to $n_r\times n_f$.

12:   $\mathrm{MONIT}$ – SUBROUTINE, supplied by the NAG Library or the user.External Procedure

MONIT is called by D02KDF at the end of each root-finding iteration and allows you to monitor the course of the computation by printing out the parameters (see Section 10 for an example).

If no monitoring is required, the dummy (sub)program D02KAY may be used. (D02KAY is included in the NAG Library.)

The specification of MONIT is:

SUBROUTINE MONIT ( NIT, IFLAG, ELAM, FINFO) INTEGER  NIT, IFLAG REAL (KIND=nag_wp)  ELAM, FINFO(15)

1:     $\mathrm{NIT}$ – INTEGERInput

On entry: the current value of the parameter MAXIT of D02KDF, this is decreased by one at each iteration.

2:     $\mathrm{IFLAG}$ – INTEGERInput

On entry: describes what phase the computation is in.

$\mathbf{IFLAG}<0$

An error occurred in the computation at this iteration; an error exit from D02KDF with $\mathbf{IFAIL}=-\mathbf{IFLAG}$ will follow.

$\mathbf{IFLAG}=1$

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

$\mathbf{IFLAG}=2$

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

3:     $\mathrm{ELAM}$ – REAL (KIND=nag_wp)Input

On entry: the current trial value of $\lambda$.

4:     $\mathrm{FINFO}\left(15\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: 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}>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. (See Section 9.2 for further information.) $\mathbf{FINFO}\left(1\right)$ 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)$

The index of the sub-interval where failure occurred, in the range $1$ to $m-3$. In case of an error in BDYVAL, it is set to $0$ or $m-2$ depending on whether the left or right boundary condition caused the error.

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

The value of the independent variable, $x$, the point at which the error occurred. In case of an error in BDYVAL, it is set to the value of XL or XR as appropriate (see the specification of BDYVAL).

$\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. These are set to zero in case of an error in BDYVAL. (See D02KEF 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. This is set to zero in the case of an error in BDYVAL.

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

The last integration mesh point. This is set to zero in the case of an error in BDYVAL.

MONIT must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02KDF is called. Parameters denoted as Input must not be changed by this procedure.

13:   $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.

On exit: $\mathbf{IFAIL}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

$\mathbf{IFAIL}=1$

A parameter error. All parameters (except IFAIL) are left unchanged. The reason for the error is shown by the value of $\mathbf{HMAX}\left(2,1\right)$ as follows:

$\mathbf{HMAX}\left(2,1\right)=1$:	$\mathbf{M}<4$;
$\mathbf{HMAX}\left(2,1\right)=2$:	$\mathbf{K}<0$;
$\mathbf{HMAX}\left(2,1\right)=3$:	$\mathbf{TOL}\le 0.0$;
$\mathbf{HMAX}\left(2,1\right)=4$:	$\mathbf{XPOINT}\left(1\right)$ to $\mathbf{XPOINT}\left(m\right)$ are not in ascending order. $\mathbf{HMAX}\left(2,2\right)$ gives the position $i$ in XPOINT where this was detected.

$\mathbf{IFAIL}=2$

At some call to BDYVAL, invalid values were returned, that is, either $\mathbf{YL}\left(1\right)=\mathbf{YL}\left(2\right)=0.0$, or $\mathbf{YR}\left(1\right)=\mathbf{YR}\left(2\right)=0.0$ (a programming error in BDYVAL). See the last call of MONIT for details.

This error exit will also occur if $p\left(x\right)$ is zero at the point where the boundary condition is imposed. Probably BDYVAL was called with XL equal to a singular end point $a$ or with XR equal to a singular end point $b$.

$\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$

$\mathbf{MAXIT}>0$ on entry, and after MAXIT iterations the eigenvalue had not been found to the required accuracy.

$\mathbf{IFAIL}=5$

The ‘bracketing’ phase (with parameter 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 routine.

$\mathbf{IFAIL}=6$

$\mathbf{MAXFUN}>0$ on entry, and the last iteration was terminated because more than MAXFUN calls to COEFFN were used. See the last call of MONIT for details.

$\mathbf{IFAIL}=7$

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}=8$

At some point inside a sub-interval 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{7}$). 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.

$\mathbf{IFAIL}=9$

TOL is too small for the problem being solved and the machine precision is being used. The final value of ELAM should be a very good approximation to the eigenvalue.

$\mathbf{IFAIL}=10$

C05AZF, called by D02KDF, has terminated with the error exit corresponding to a pole of the residual function $f\left(\lambda \right)$. This error exit should not occur, but if it does, try solving the problem again with a smaller value for TOL.

$\mathbf{IFAIL}=11$

$\mathbf{IFAIL}=12$

A serious error has occurred in an internal call. 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.

See Section 3.8 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.7 in the Essential Introduction for further information.

$\mathbf{IFAIL}=-999$

Dynamic memory allocation failed.

See Section 3.6 in the Essential Introduction for further information.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

9.1  Timing

9.2  General Description of the Algorithm

9.3  The Position of the Shooting Matching Point $c$

9.4  Examples of Coding the COEFFN

SUBROUTINE COEFFN (P,Q,DQDL,X,ELAM,JINT)
...
P = X
Q = ELAM*X - NU*NU/X
DQDL = X
RETURN
END

SUBROUTINE COEFFN(P,Q,DQDL,X,ELAM,JINT)
...
IF (JINT.EQ.2) THEN
  Q = ELAM + X*X - 10.0E0
ELSE
  Q = ELAM + 6.0E0/ABS(X)
ENDIF
P = 1.0E0
DQDL = 1.0E0
RETURN
END

SUBROUTINE COEFFN(P,Q,DQDL,X,ELAM,JINT)
...
P = 1.0E0
DQDL = 1.0E0 - 2.0E0*EXP(-100.0E0*X*X)
Q = ELAM*DQDL
RETURN
END

9.5  Examples of Boundary Conditions at Singular Points

SUBROUTINE BDYVAL (XL,XR,ELAM,YL,YR)
real XL, XR, ELAM, YL(3), YR(3)
YL(1) = XL
YL(2) = 2.0E0
YR(1) = 1.0E0
YR(2) = -SQRT(XR-ELAM)
RETURN
END

9.6  The Sensitivity Parameters ${\sigma }_l$ and ${\sigma }_r$

9.7  ‘Missed Zeros’

10  Example

10.1  Program Text

Program Text (d02kdfe.f90)

10.2  Program Data

Program Data (d02kdfe.d)

10.3  Program Results

Program Results (d02kdfe.r)