D02 Chapter Contents
D02 Chapter Introduction
NAG Library Manual

# NAG Library Routine DocumentD02PGF

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

D02PGF is a reverse communication one-step routine for solving an initial value problem for a first-order system of ordinary differential equations using Runge–Kutta methods. The direct communication version of this routine is D02PFF. See Section 3.3.3 in How to Use the NAG Library and its Documentation for the difference between forward and reverse communication.

## 2  Specification

 SUBROUTINE D02PGF ( IREVCM, N, T, Y, YP, IWSAV, RWSAV, IFAIL)
 INTEGER IREVCM, N, IWSAV(130), IFAIL REAL (KIND=nag_wp) T, Y(N), YP(N), RWSAV(32*N+350)

## 3  Description

D02PGF and its associated routines (D02PHF, D02PJF, D02PQF, D02PRF, D02PTF and D02PUF) 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.
D02PGF is designed to be used in complicated tasks when solving systems of ordinary differential equations. You must first call D02PQF to specify the problem and how it is to be solved. Thereafter you (repeatedly) call D02PGF in reverse communication loops to take one integration step at a time from TSTART in the direction of TEND (as specified in D02PQF). In this manner D02PGF returns an approximation to the solution Y and its derivative YP at successive points T. If D02PGF encounters some difficulty in taking a step, the integration is not advanced and the routine returns with the same values of T, Y and YP as returned on the previous successful step. D02PGF 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 D02PQF you can specify either the first step size for D02PGF to attempt or it computes automatically an appropriate value. Thereafter D02PGF estimates an appropriate step size for its next step. This value and other details of the integration can be obtained after a completed step by D02PGF by a call to D02PTF. The local error is controlled at every step as specified in D02PQF. If you wish to assess the true error, you must set METHOD to a positive value in the call to D02PQF. This assessment can be obtained after any call to D02PGF by a call to D02PUF.
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 D02PHF and D02PJF 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 D02PJF. This is very valuable when you want to find where something happens, e.g., where a particular solution component vanishes. (ii) Alternatively, set TEND to the desired value and integrate to TEND. D02PGF 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{T}}={\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 D02PQF, but you should not do this. You should use D02PRF 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 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  Arguments

Note: this routine uses reverse communication. Its use involves an initial entry, intermediate exits and re-entries, and a final exit, as indicated by the argument IREVCM. Between intermediate exits and re-entries, all arguments other than those specified by the value of IREVCM must remain unchanged.
1:     $\mathrm{IREVCM}$ – INTEGERInput/Output
On initial entry: IREVCM must be set to zero to indicate that a new step is being taken.
On intermediate re-entry: IREVCM should remain unchanged.
On intermediate exit: IREVCM returns a value $\text{}>0$ to indicate that a function evaluation is required prior to re-entry; the value of the derivatives ${y}^{\prime }=f\left(t,y\right)$ must be returned in YP where the value of $t$ is supplied in T and the values $y\left(t\right)$ are supplied in the array Y. The value of IREVCM indicates the reason for the function evaluation as follows:
${\mathbf{IREVCM}}=1$
For initial entry values of T and Y.
${\mathbf{IREVCM}}=2$
To determine stiffness of system.
${\mathbf{IREVCM}}=3$
For the stages of the primary step.
${\mathbf{IREVCM}}=4$
A final stage of the primary step.
${\mathbf{IREVCM}}=5$
For the stages of a secondary step (if global error assessment is required).
On final exit:
${\mathbf{IREVCM}}=-1$
Successful exit; T, Y and YP contain the solution at the end of a successful integration step.
${\mathbf{IREVCM}}=-2$
Error exit; IFAIL should be interrogated to determine the nature of the error.
2:     $\mathrm{N}$ – INTEGERInput
On entry: $n$, the number of ordinary differential equations in the system to be solved.
Constraint: ${\mathbf{N}}\ge 1$. This must be the same value as supplied in a previous call to D02PQF.
3:     $\mathrm{T}$ – REAL (KIND=nag_wp)Output
On intermediate exit: T contains the value of the independent variable $t$ at which the derivatives ${y}^{\prime }$ are to be evaluated.
On final exit: the value of $t$ at which a solution has been computed following a successful step.
4:     $\mathrm{Y}\left({\mathbf{N}}\right)$ – REAL (KIND=nag_wp) arrayOutput
On intermediate exit: Y contains the value of the solution $y$ at which the derivatives ${y}^{\prime }$ are to be evaluated.
On final exit: the approximation to the solution computed following a successful step.
5:     $\mathrm{YP}\left({\mathbf{N}}\right)$ – REAL (KIND=nag_wp) arrayInput
On initial entry: YP need not be set.
On intermediate re-entry: YP must contain the value of the derivatives ${y}^{\prime }=f\left(t,y\right)$ where $t$ is supplied in T and $y$ is supplied in the array Y.
6:     $\mathrm{IWSAV}\left(130\right)$ – INTEGER arrayCommunication Array
7:     $\mathrm{RWSAV}\left(32×{\mathbf{N}}+350\right)$ – REAL (KIND=nag_wp) arrayCommunication Array
On entry: these must be the same arrays supplied in a previous call to D02PQF. They must remain unchanged between calls.
On exit: information about the integration for use on subsequent calls to D02PGF or other associated routines.
8:     $\mathrm{IFAIL}$ – INTEGERInput/Output
On initial entry: IFAIL must be set to $0$, $-1\text{​ 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\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 arguments 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 final 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}}=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:
${\mathbf{IFAIL}}=1$
A call to this routine cannot be made after it has returned an error.
The setup routine must be called to start another problem.
${\mathbf{IREVCM}}<0$ on entry.
On entry, a previous call to the setup routine has not been made or the communication arrays have become corrupted.
On entry, ${\mathbf{N}}=〈\mathit{\text{value}}〉$, but the value passed to the setup routine was ${\mathbf{N}}=〈\mathit{\text{value}}〉$.
On entry, the communication arrays have become corrupted, or a catastrophic error has already been detected elsewhere. You cannot continue integrating the problem.
TEND, as specified in the setup routine, has already been reached. To start a new problem, you will need to call the setup routine. To continue integration beyond TEND then D02PRF must first be called to reset TEND to a new end value.
${\mathbf{IFAIL}}=2$
More than $100$ output points have been obtained by integrating to TEND (as specified in the setup routine). They have been so clustered that it would probably be (much) more efficient to use the interpolation routine. However, you can continue integrating the problem.
${\mathbf{IFAIL}}=3$
Approximately $〈\mathit{\text{value}}〉$ function evaluations have been used to compute the solution since the integration started or since this message was last printed. However, you can continue integrating the problem.
${\mathbf{IFAIL}}=4$
Approximately $〈\mathit{\text{value}}〉$ function evaluations have been used to compute the solution since the integration started or since this message was last printed. Your problem has been diagnosed as stiff. If the situation persists, it will cost roughly $〈\mathit{\text{value}}〉$ times as much to reach TEND (setup) as it has cost to reach the current time. You should probably call routines intended for stiff problems. However, you can continue integrating the problem.
${\mathbf{IFAIL}}=5$
In order to satisfy your error requirements the solver has to use a step size of $〈\mathit{\text{value}}〉$ at the current time, $〈\mathit{\text{value}}〉$. This step size is too small for the machine precision, and is smaller than $〈\mathit{\text{value}}〉$.
${\mathbf{IFAIL}}=6$
The global error assessment algorithm failed at start of integration.
The integration is being terminated.
The global error assessment may not be reliable for times beyond $〈\mathit{\text{value}}〉$.
The integration is being terminated.
${\mathbf{IFAIL}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{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.
${\mathbf{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 integration is determined by the arguments TOL and THRESH in a prior call to D02PQF (see the routine document for D02PQF for further details and advice). Note that only the local error at each step is controlled by these arguments. 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

D02PGF 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 D02PGF returns with ${\mathbf{IFAIL}}>{\mathbf{1}}$ then the values returned in T and Y are for the last successful step, or the initial conditions supplied if no successful step has been taken.
If D02PGF returns with ${\mathbf{IFAIL}}={\mathbf{5}}$ and the accuracy specified by TOL and THRESH 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 Y 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 D02PGF (except when ${\mathbf{IFAIL}}={\mathbf{1}}$) by a call to D02PTF. If ${\mathbf{METHOD}}>0$ in the call to D02PQF, global error assessment is available after any return from D02PGF (except when ${\mathbf{IFAIL}}={\mathbf{1}}$) by a call to D02PUF.
After a failure with ${\mathbf{IFAIL}}={\mathbf{5}}$ or ${\mathbf{6}}$ each of the diagnostic routines D02PTF and D02PUF may be called only once.
If D02PGF returns with ${\mathbf{IFAIL}}={\mathbf{4}}$ then it is advisable to change to another code more suited to the solution of stiff problems. D02PGF 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 regular intervals using the interpolation routines D02PHF and D02PJF within integration steps across the range; points on the range at which ${y}_{1}$ or ${y}_{2}$ change sign are also evaluated using a combination of the root finding routine C05AZF and the interpolation routines. We use a medium order Runge–Kutta method (${\mathbf{METHOD}}=2$) with tolerance ${\mathbf{TOL}}=\text{1.0E−5}$.

### 10.1  Program Text

Program Text (d02pgfe.f90)

### 10.2  Program Data

Program Data (d02pgfe.d)

### 10.3  Program Results

Program Results (d02pgfe.r)