D02BJF (PDF version)
D02 Chapter Contents
D02 Chapter Introduction
NAG Library Manual

NAG Library Routine Document

D02BJF

Note:  before using this routine, please read the Users' Note for your implementation to check the interpretation of bold italicised terms and other implementation-dependent details.

 Contents

    1  Purpose
    7  Accuracy

1  Purpose

D02BJF integrates a system of first-order ordinary differential equations over an interval with suitable initial conditions, using a fixed order Runge–Kutta method, until a user-specified function, if supplied, of the solution is zero, and returns the solution at points specified by you, if desired.

2  Specification

SUBROUTINE D02BJF ( X, XEND, N, Y, FCN, TOL, RELABS, OUTPUT, G, W, IFAIL)
INTEGER  N, IFAIL
REAL (KIND=nag_wp)  X, XEND, Y(N), TOL, G, W(20*N)
CHARACTER(1)  RELABS
EXTERNAL  FCN, OUTPUT, G

3  Description

D02BJF advances the solution of a system of ordinary differential equations
yi=fix,y1,y2,,yn,  i=1,2,,n,  
from x=X to x=XEND using a fixed order Runge–Kutta method. The system is defined by FCN, which evaluates fi in terms of x and y=y1,y2,,yn. The initial values of y=y1,y2,,yn must be given at x=X.
The solution is returned via the OUTPUT supplied by you and at points specified by you, if desired: this solution is obtained by C1 interpolation on solution values produced by the method. As the integration proceeds a check can be made on the user-specified function gx,y to determine an interval where it changes sign. The position of this sign change is then determined accurately by C1 interpolation to the solution. It is assumed that gx,y is a continuous function of the variables, so that a solution of gx,y=0 can be determined by searching for a change in sign in gx,y. The accuracy of the integration, the interpolation and, indirectly, of the determination of the position where gx,y=0, is controlled by the arguments TOL and RELABS.

4  References

Shampine L F (1994) Numerical solution of ordinary differential equations Chapman and Hall

5  Arguments

1:     X – REAL (KIND=nag_wp)Input/Output
On entry: the initial value of the independent variable x.
On exit: if g is supplied by you, it contains the point where gx,y=0, unless gx,y0 anywhere on the range X to XEND, in which case, X will contain XEND (and the error indicator IFAIL=6 is set); if g is not supplied by you it contains XEND. However, if an error has occurred, it contains the value of x at which the error occurred.
2:     XEND – REAL (KIND=nag_wp)Input
On entry: the final value of the independent variable. If XEND<X, integration will proceed in the negative direction.
Constraint: XENDX.
3:     N – INTEGERInput
On entry: n, the number of equations.
Constraint: N>0.
4:     YN – REAL (KIND=nag_wp) arrayInput/Output
On entry: the initial values of the solution y1,y2,,yn at x=X.
On exit: the computed values of the solution at the final point x=X.
5:     FCN – SUBROUTINE, supplied by the user.External Procedure
FCN must evaluate the functions fi (i.e., the derivatives yi) for given values of its arguments x,y1,,yn.
The specification of FCN is:
SUBROUTINE FCN ( X, Y, F)
REAL (KIND=nag_wp)  X, Y(*), F(*)
1:     X – REAL (KIND=nag_wp)Input
On entry: x, the value of the independent variable.
2:     Y* – REAL (KIND=nag_wp) arrayInput
On entry: yi, for i=1,2,,n, the value of the variable.
3:     F* – REAL (KIND=nag_wp) arrayOutput
On exit: the value of fi, for i=1,2,,n.
FCN must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02BJF is called. Arguments denoted as Input must not be changed by this procedure.
6:     TOL – REAL (KIND=nag_wp)Input
On entry: a positive tolerance for controlling the error in the integration. Hence TOL affects the determination of the position where gx,y=0, if g is supplied.
D02BJF 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 D02BJF 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 D02BJF with RELABS='D' and with each of TOL=10.0-p and TOL=10.0-p-1 where p correct significant digits are required in the solution, y. The accuracy of the value x such that gx,y=0 is indirectly controlled by varying TOL. You should experiment to determine this accuracy.
Constraint: 10.0×machine precision<TOL<0.01.
7:     RELABS – CHARACTER(1)Input
On entry: the type of error control. At each step in the numerical solution an estimate of the local error, est, is made. For the current step to be accepted the following condition must be satisfied:
est =maxei/ τr × maxyi,τa 1.0  
where τr and τa are defined by
RELABS τr τa
'M' TOL 1.0
'A' εr TOL/εr
'R' TOL εa
'D' TOL εa
where εr and εa are small machine-dependent numbers and ei is an estimate of the local error at yi, computed internally. If the 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 'R'.
Constraint: RELABS='M', 'A', 'R' or 'D'.
8:     OUTPUT – SUBROUTINE, supplied by the NAG Library or the user.External Procedure
OUTPUT permits access to intermediate values of the computed solution (for example to print or plot them), at successive user-specified points. It is initially called by D02BJF with XSOL=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, D02BJF will integrate to XEND with no further calls to OUTPUT; if a call to OUTPUT is required at the point XSOL=XEND, then XSOL must be given precisely the value XEND.
The specification of OUTPUT is:
SUBROUTINE OUTPUT ( XSOL, Y)
REAL (KIND=nag_wp)  XSOL, Y(*)
1:     XSOL – REAL (KIND=nag_wp)Input/Output
On entry: the output value of the independent variable x.
On exit: you must set XSOL to the next value of x at which OUTPUT is to be called.
2:     Y* – REAL (KIND=nag_wp) arrayInput
On entry: the computed solution at the point XSOL.
OUTPUT must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02BJF is called. Arguments denoted as Input must not be changed by this procedure.
If you do not wish to access intermediate output, the actual argument OUTPUT must be the dummy routine D02BJX. (D02BJX is included in the NAG Library.)
9:     G – REAL (KIND=nag_wp) FUNCTION, supplied by the user.External Procedure
G must evaluate the function gx,y for specified values x,y. It specifies the function g for which the first position x where gx,y=0 is to be found.
The specification of G is:
FUNCTION G ( X, Y)
REAL (KIND=nag_wp) G
REAL (KIND=nag_wp)  X, Y(*)
where n is the value of N in the call of D02BJF.
1:     X – REAL (KIND=nag_wp)Input
On entry: x, the value of the independent variable.
2:     Y* – REAL (KIND=nag_wp) arrayInput
On entry: yi, for i=1,2,,n, the value of the variable.
G must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02BJF is called. Arguments denoted as Input must not be changed by this procedure.
If you do not require the root-finding option, the actual argument G must be the dummy routine D02BJW. (D02BJW is included in the NAG Library.)
10:   W20×N – REAL (KIND=nag_wp) arrayWorkspace
11:   IFAIL – INTEGERInput/Output
On entry: IFAIL must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ 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 argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of IFAIL on exit.
On exit: IFAIL=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6  Error Indicators and Warnings

If on entry IFAIL=0 or -1, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
IFAIL=1
On entry,TOL0.01,
orTOL is too small
orN0,
orRELABS'M', 'A', 'R' or 'D',
orX=XEND.
IFAIL=2
With the given value of TOL, no further progress can be made across the integration range from the current point x=X. (See Section 9 for a discussion of this error exit.) The components Y1,Y2,,YN contain the computed values of the solution at the current point x=X. If you have supplied g, then no point at which gx,y changes sign has been located up to the point x=X.
IFAIL=3
TOL is too small for D02BJF to take an initial step. X and Y1,Y2,,YN retain their initial values.
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.
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.
IFAIL=6
At no point in the range X to XEND did the function gx,y change sign, if g was supplied. It is assumed that gx,y=0 has no solution.
IFAIL=7
A serious error has occurred in an internal call to an interpolation routine. Check all (sub)program calls and array dimensions. Seek expert help.
IFAIL=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
IFAIL=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7  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 RELABS='D' unless you have a good reason for a different choice.
If the problem is a root-finding one, then the accuracy of the root determined will depend on the properties of gx,y and on the values of TOL and RELABS. You should try to code G without introducing any unnecessary cancellation errors.

8  Parallelism and Performance

D02BJF makes calls to BLAS and/or LAPACK routines, which may be threaded within the vendor library used by this implementation. Consult the documentation for the vendor library for further information.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9  Further Comments

If more than one root is required, then to determine the second and later roots D02BJF may be called again starting a short distance past the previously determined roots. Alternatively you may construct your own root-finding code using C05AZF, D02PFF and D02PSF.
If D02BJF fails with IFAIL=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 routine, the system may be very stiff (see below) or so badly scaled that it cannot be solved to the required accuracy.
If D02BJF fails with IFAIL=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 well-behaved 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 routine will usually stop with IFAIL=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 routine will use very small steps in x (internally to D02BJF) to preserve stability. This will exhibit itself by making the computing time excessively long, or occasionally by an exit with IFAIL=2. Runge–Kutta methods are not efficient in such cases, and you should try D02EJF.

10  Example

This example illustrates the solution of four different problems. In each case the differential system (for a projectile) is
y=tanϕ v= -0.032tanϕv- 0.02v cosϕ ϕ= -0.032v2  
over an interval X=0.0 to XEND=10.0 starting with values y=0.5, v=0.5 and ϕ=π/5. We solve each of the following problems with local error tolerances 1.0E−4 and 1.0E−5.
(i) To integrate to x=10.0 producing intermediate output at intervals of 2.0 until a root is encountered where y=0.0.
(ii) As (i) but with no intermediate output.
(iii) As (i) but with no termination on a root-finding condition.
(iv) As (i) but with no intermediate output and no root-finding termination condition.

10.1  Program Text

Program Text (d02bjfe.f90)

10.2  Program Data

Program Data (d02bjfe.d)

10.3  Program Results

Program Results (d02bjfe.r)

GnuplotProduced by GNUPLOT 4.6 patchlevel 3 −4 −3 −2 −1 0 1 2 0 2 4 6 8 10 Solution x Example Program ODE Solution using Runge-Kutta with Root-finding height velocity angle height = 0 gnuplot_plot_1 gnuplot_plot_2 gnuplot_plot_3 gnuplot_plot_4

D02BJF (PDF version)
D02 Chapter Contents
D02 Chapter Introduction
NAG Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2016