D02 Chapter Contents
D02 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentD02PDF

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.

## 1  Purpose

D02PDF is a one-step routine for solving an initial value problem for a first-order system of ordinary differential equations using Runge–Kutta methods.

## 2  Specification

 SUBROUTINE D02PDF ( F, TNOW, YNOW, YPNOW, WORK, IFAIL)
 INTEGER IFAIL REAL (KIND=nag_wp) TNOW, YNOW(*), YPNOW(*), WORK(*) EXTERNAL F

## 3  Description

D02PDF and its associated routines (D02PVF, D02PWF, D02PXF, D02PYF and D02PZF) solve an initial value problem for a first-order system of ordinary differential equations. The routines, based on Runge–Kutta methods and derived from RKSUITE (see Brankin et al. (1991)), integrate
 $y′=ft,y given yt0=y0$
where $y$ is the vector of $\mathit{n}$ solution components and $t$ is the independent variable.
D02PDF is designed to be used in complicated tasks when solving systems of ordinary differential equations. You must first call D02PVF to specify the problem and how it is to be solved. Thereafter you (repeatedly) call D02PDF to take one integration step at a time from TSTART in the direction of TEND (as specified in D02PVF). In this manner D02PDF returns an approximation to the solution YNOW and its derivative YPNOW at successive points TNOW. If D02PDF encounters some difficulty in taking a step, the integration is not advanced and the routine returns with the same values of TNOW, YNOW and YPNOW as returned on the previous successful step. D02PDF tries to advance the integration as far as possible subject to passing the test on the local error and not going past TEND.
In the call to D02PVF you can specify either the first step size for D02PDF to attempt or that it compute automatically an appropriate value. Thereafter D02PDF estimates an appropriate step size for its next step. This value and other details of the integration can be obtained after any call to D02PDF by a call to D02PYF. The local error is controlled at every step as specified in D02PVF. If you wish to assess the true error, you must set ${\mathbf{ERRASS}}=\mathrm{.TRUE.}$ in the call to D02PVF. This assessment can be obtained after any call to D02PDF by a call to D02PZF.
If you want answers at specific points there are two ways to proceed:
 (i) The more efficient way is to step past the point where a solution is desired, and then call D02PXF to get an answer there. Within the span of the current step, you can get all the answers you want at very little cost by repeated calls to D02PXF. This is very valuable when you want to find where something happens, e.g., where a particular solution component vanishes. You cannot proceed in this way with ${\mathbf{METHOD}}=3$. (ii) The other way to get an answer at a specific point is to set TEND to this value and integrate to TEND. D02PDF will not step past TEND, so when a step would carry it past, it will reduce the step size so as to produce an answer at TEND exactly. After getting an answer there (${\mathbf{TNOW}}={\mathbf{TEND}}$), you can reset TEND to the next point where you want an answer, and repeat. TEND could be reset by a call to D02PVF, but you should not do this. You should use D02PWF instead because it is both easier to use and much more efficient. This way of getting answers at specific points can be used with any of the available methods, but it is the only way with ${\mathbf{METHOD}}=3$. It can be inefficient. Should this be the case, the code will bring the matter to your attention.

## 4  References

Brankin R W, Gladwell I and Shampine L F (1991) RKSUITE: A suite of Runge–Kutta codes for the initial value problems for ODEs SoftReport 91-S1 Southern Methodist University

## 5  Parameters

1:     $\mathrm{F}$ – SUBROUTINE, supplied by the user.External Procedure
F must evaluate the functions ${f}_{i}$ (that is the first derivatives ${y}_{i}^{\prime }$) for given values of the arguments $t$, ${y}_{i}$.
The specification of F is:
 SUBROUTINE F ( T, Y, YP)
 REAL (KIND=nag_wp) T, Y(*), YP(*)
In the description of the parameters of D02PDF below, $\mathit{n}$ denotes the value of NEQ in the call of D02PVF.
1:     $\mathrm{T}$ – REAL (KIND=nag_wp)Input
On entry: $t$, the current value of the independent variable.
2:     $\mathrm{Y}\left(*\right)$ – REAL (KIND=nag_wp) arrayInput
On entry: the current values of the dependent variables, ${y}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$.
3:     $\mathrm{YP}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput
On exit: the values of ${f}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$.
F must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02PDF is called. Parameters denoted as Input must not be changed by this procedure.
2:     $\mathrm{TNOW}$ – REAL (KIND=nag_wp)Output
On exit: $t$, the value of the independent variable at which a solution has been computed.
3:     $\mathrm{YNOW}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput
Note: the dimension of the array YNOW must be at least $\mathit{n}$.
On exit: an approximation to the solution at TNOW. The local error of the step to TNOW was no greater than permitted by the specified tolerances (see D02PVF).
4:     $\mathrm{YPNOW}\left(*\right)$ – REAL (KIND=nag_wp) arrayOutput
Note: the dimension of the array YPNOW must be at least $\mathit{n}$.
On exit: an approximation to the derivative of the solution at TNOW.
5:     $\mathrm{WORK}\left(*\right)$ – REAL (KIND=nag_wp) arrayInput/Output
Note: the dimension of the array WORK must be at least ${\mathbf{LENWRK}}$ (see D02PVF).
On entry: this must be the same array as supplied to D02PVF. It must remain unchanged between calls.
On exit: information about the integration for use on subsequent calls to D02PDF or other associated routines.
6:     $\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, because for this routine the values of the output parameters may be useful even if ${\mathbf{IFAIL}}\ne {\mathbf{0}}$ on exit, the recommended value is $-1$. When the value $-\mathbf{1}\text{​ or ​}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

If on entry ${\mathbf{IFAIL}}={\mathbf{0}}$ or $-{\mathbf{1}}$, explanatory error messages are output on the current error message unit (as defined by X04AAF).
Errors or warnings detected by the routine:
${\mathbf{IFAIL}}=1$
On entry, an invalid call to D02PDF was made, for example without a previous call to the setup routine D02PVF. You cannot continue integrating the problem.
${\mathbf{IFAIL}}=2$
D02PDF is being used inefficiently because the step size has been reduced drastically many times to obtain answers at many points TEND. If you really need the solution at this many points, you should use D02PXF to obtain the answers inexpensively. If you need to change from ${\mathbf{METHOD}}=3$ to do this, restart the integration from TNOW, YNOW by a call to D02PVF. If you wish to continue as before, call D02PDF again. The monitor of this kind of inefficiency will be reset automatically so that the integration can proceed.
${\mathbf{IFAIL}}=3$
A considerable amount of work has been expended in the (primary) integration. This is measured by counting the number of calls to F. At least $5000$ calls have been made since the last time this counter was reset. Calls to F in a secondary integration for global error assessment (when ${\mathbf{ERRASS}}=\mathrm{.TRUE.}$ in the call to D02PVF) are not counted in this total. The integration was interrupted. If you wish to continue on towards TEND, just call D02PDF again. The counter measuring work will be reset to zero automatically.
${\mathbf{IFAIL}}=4$
It appears that this problem is stiff. The methods implemented in D02PDF can solve such problems, but they are inefficient. You should change to another code based on methods appropriate for stiff problems. The integration was interrupted. If you want to continue on towards TEND, just call D02PDF again. The stiffness monitor will be reset automatically.
${\mathbf{IFAIL}}=5$
It does not appear possible to achieve the accuracy specified by TOL and THRES in the call to D02PVF with the precision available on the computer being used and with this value of METHOD. You cannot continue integrating this problem. A larger value for METHOD, if possible, will permit greater accuracy with this precision. To increase METHOD and/or continue with larger values of TOL and/or THRES, restart the integration from TNOW, YNOW by a call to D02PVF.
${\mathbf{IFAIL}}=6$
(This error exit can only occur if ${\mathbf{ERRASS}}=\mathrm{.TRUE.}$ in the call to D02PVF.) The global error assessment may not be reliable beyond the current integration point TNOW. This may occur because either too little or too much accuracy has been requested or because $f\left(t,y\right)$ is not smooth enough for values of $t$ just beyond TNOW and current values of the solution $y$. The integration cannot be continued. This return does not mean that you cannot integrate past TNOW, rather that you cannot do it with ${\mathbf{ERRASS}}=\mathrm{.TRUE.}$. However, it may also indicate problems with the primary integration.
${\mathbf{IFAIL}}=-99$
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

The accuracy of integration is determined by the parameters TOL and THRES in a prior call to D02PVF. Note that only the local error at each step is controlled by these parameters. The error estimates obtained are not strict bounds but are usually reliable over one step. Over a number of steps the overall error may accumulate in various ways, depending on the properties of the differential system.

## 8  Parallelism and Performance

D02PDF is not threaded by NAG in any implementation.
D02PDF 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.

If D02PDF returns with ${\mathbf{IFAIL}}={\mathbf{5}}$ and the accuracy specified by TOL and THRES is really required then you should consider whether there is a more fundamental difficulty. For example, the solution may contain a singularity. In such a region the solution components will usually be large in magnitude. Successive output values of YNOW should be monitored with the aim of trapping the solution before the singularity. In any case numerical integration cannot be continued through a singularity, and analytical treatment may be necessary.
Performance statistics are available after any return from D02PDF (except when ${\mathbf{IFAIL}}={\mathbf{1}}$) by a call to D02PYF. If ${\mathbf{ERRASS}}=\mathrm{.TRUE.}$ in the call to D02PVF, global error assessment is available after any return from D02PDF (except when ${\mathbf{IFAIL}}={\mathbf{1}}$) by a call to D02PZF.
After a failure with ${\mathbf{IFAIL}}={\mathbf{5}}$ or ${\mathbf{6}}$ the diagnostic routines D02PYF and D02PZF may be called only once.
If D02PDF returns with ${\mathbf{IFAIL}}={\mathbf{4}}$ then it is advisable to change to another code more suited to the solution of stiff problems. D02PDF will not return with ${\mathbf{IFAIL}}={\mathbf{4}}$ if the problem is actually stiff but it is estimated that integration can be completed using less function evaluations than already computed.

## 10  Example

This example solves the equation
 $y′′ = -y , y0 = 0 , y′0 = 1$
reposed as
 $y1′ = y2$
 $y2′ = -y1$
over the range $\left[0,2\pi \right]$ with initial conditions ${y}_{1}=0.0$ and ${y}_{2}=1.0$. We use relative error control with threshold values of $\text{1.0E−8}$ for each solution component and print the solution at each integration step across the range. We use a medium order Runge–Kutta method (${\mathbf{METHOD}}=2$) with tolerances ${\mathbf{TOL}}=\text{1.0E−4}$ and ${\mathbf{TOL}}=\text{1.0E−5}$ in turn so that we may compare the solutions. The value of $\pi$ is obtained by using X01AAF.
Note that the length of WORK is large enough for any valid combination of input arguments to D02PVF.

### 10.1  Program Text

Program Text (d02pdfe.f90)

### 10.2  Program Data

Program Data (d02pdfe.d)

### 10.3  Program Results

Program Results (d02pdfe.r)