NAG Library Routine Document
d02qgf (ivp_adams_roots_revcom)
1
Purpose
d02qgf is a reverse communication routine for integrating a nonstiff system of firstorder ordinary differential equations using a variableorder variablestep Adams' method. A rootfinding facility is provided.
2
Specification
Fortran Interface
Subroutine d02qgf ( 
neqf, t, y, tout, neqg, root, irevcm, trvcm, yrvcm, yprvcm, grvcm, kgrvcm, rwork, lrwork, iwork, liwork, ifail) 
Integer, Intent (In)  ::  neqf, neqg, lrwork, liwork  Integer, Intent (Inout)  ::  irevcm, kgrvcm, iwork(liwork), ifail  Integer, Intent (Out)  ::  yrvcm, yprvcm  Real (Kind=nag_wp), Intent (In)  ::  tout, grvcm  Real (Kind=nag_wp), Intent (Inout)  ::  t, y(neqf), rwork(lrwork)  Real (Kind=nag_wp), Intent (Out)  ::  trvcm  Logical, Intent (Out)  ::  root 

C Header Interface
#include nagmk26.h
void 
d02qgf_ (const Integer *neqf, double *t, double y[], const double *tout, const Integer *neqg, logical *root, Integer *irevcm, double *trvcm, Integer *yrvcm, Integer *yprvcm, const double *grvcm, Integer *kgrvcm, double rwork[], const Integer *lrwork, Integer iwork[], const Integer *liwork, Integer *ifail) 

3
Description
Given the initial values
$x,{y}_{1},{y}_{2},\dots ,{y}_{{\mathbf{neqf}}}$ d02qgf integrates a nonstiff system of firstorder differential equations of the type
from
$x={\mathbf{t}}$ to
$x={\mathbf{tout}}$ using a variableorder variablestep Adams' method. You define the system by reverse communication, evaluating
${f}_{i}$ in terms of
$x$ and
${y}_{1},{y}_{2},\dots ,{y}_{{\mathbf{neqf}}}$, and
${y}_{1},{y}_{2},\dots ,{y}_{{\mathbf{neqf}}}$ are supplied at
$x={\mathbf{t}}$ by
d02qgf. The routine is capable of finding roots (values of
$x$) of prescribed event functions of the form
Each
${g}_{j}$ is considered to be independent of the others so that roots are sought of each
${g}_{j}$ individually. The root reported by the routine will be the first root encountered by any
${g}_{j}$. Two techniques for determining the presence of a root in an integration step are available: the sophisticated method described in
Watts (1985) and a simplified method whereby sign changes in each
${g}_{j}$ are looked for at the ends of each integration step. You also define each
${g}_{j}$ by reverse communication. In onestep mode the routine returns an approximation to the solution at each integration point. In interval mode this value is returned at the end of the integration range. If a root is detected this approximation is given at the root. You select the mode of operation, the error control, the rootfinding technique and various optional inputs by a prior call to the setup routine
d02qwf.
For a description of the practical implementation of an Adams' formula see
Shampine and Gordon (1975).
4
References
Shampine L F and Gordon M K (1975) Computer Solution of Ordinary Differential Equations – The Initial Value Problem W H Freeman & Co., San Francisco
Shampine L F and Watts H A (1979) DEPAC – design of a user oriented package of ODE solvers Report SAND792374 Sandia National Laboratory
Watts H A (1985) RDEAM – An Adams ODE code with root solving capability Report SAND851595 Sandia National Laboratory
5
Arguments
Note: this routine uses
reverse communication. Its use involves an initial entry, intermediate exits and reentries, and a final exit, as indicated by the argument
irevcm. Between intermediate exits and reentries,
all arguments other than grvcm and rwork must remain unchanged.
 1: $\mathbf{neqf}$ – IntegerInput

On initial entry: the number of firstorder ordinary differential equations to be solved by
d02qgf. It must contain the same value as the argument
neqf used in the prior call to
d02qwf.
Constraint:
${\mathbf{neqf}}\ge 1$.
 2: $\mathbf{t}$ – Real (Kind=nag_wp)Input/Output

On initial entry: that is after a call to
d02qwf with
${\mathbf{statef}}=\text{'S'}$,
t must be set to the initial value of the independent variable
$x$.
On final exit: the value of
$x$ at which
$y$ has been computed. This may be an intermediate output point, a root,
tout or a point at which an error has occurred. If the integration is to be continued, possibly with a new value for
tout,
t must not be changed.
 3: $\mathbf{y}\left({\mathbf{neqf}}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On initial entry: the initial values of the solution ${y}_{1},{y}_{2},\dots ,{y}_{{\mathbf{neqf}}}$.
On final exit: the computed values of the solution at the exit value of
t. If the integration is to be continued, possibly with a new value for
tout, these values must not be changed.
 4: $\mathbf{tout}$ – Real (Kind=nag_wp)Input

On initial entry: the next value of
$x$ at which a computed solution is required. For the initial
t, the input value of
tout is used to determine the direction of integration. Integration is permitted in either direction. If
${\mathbf{tout}}={\mathbf{t}}$ on exit,
tout must be reset beyond
t in the direction of integration, before any continuation call.
 5: $\mathbf{neqg}$ – IntegerInput

On initial entry: the number of event functions which you are defining for rootfinding. If rootfinding is not required the value for
neqg must be
$\text{}\le 0$. Otherwise it must be the same value as the argument
neqg used in the prior call to
d02qwf.
 6: $\mathbf{root}$ – LogicalOutput

On final exit: if rootfinding was required (
${\mathbf{neqg}}>0$ on entry),
root specifies whether or not the output value of the argument
t is a root of one of the event functions. If
${\mathbf{root}}=\mathrm{.FALSE.}$, no root was detected, whereas
${\mathbf{root}}=\mathrm{.TRUE.}$ indicates a root and you should make a call to
d02qyf for further information.
If rootfinding was not required (${\mathbf{neqg}}=0$ on entry), ${\mathbf{root}}=\mathrm{.FALSE.}$.
 7: $\mathbf{irevcm}$ – IntegerInput/Output

On initial entry: must have the value $0$.
On intermediate exit:
specifies what action you must take before reentering
d02qgf with irevcm unchanged.
 ${\mathbf{irevcm}}=1$, $2$, $3$, $4$, $5$, $6$ or $7$
 Indicates that you must supply ${y}^{\prime}=f\left(x,y\right)$, where $x$ is given by trvcm and
${y}_{\mathit{i}}$ is returned in ${\mathbf{y}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$ when ${\mathbf{yrvcm}}=0$ and
${\mathbf{rwork}}\left({\mathbf{yrvcm}}+\mathit{i}1\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$ when ${\mathbf{yrvcm}}\ne 0$.
${y}_{\mathit{i}}^{\prime}$ should be placed in location ${\mathbf{rwork}}\left({\mathbf{yprvcm}}+\mathit{i}1\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$.
 ${\mathbf{irevcm}}=8$
 Indicates that the current step was not successful due to error test failure. The only information supplied to you on this return is the current value of the independent variable t, as given by trvcm. No values must be changed before reentering d02qgf. This facility enables you to determine the number of unsuccessful steps.
 ${\mathbf{irevcm}}=9$, $10$, $11$ or $12$
 Indicates that you must supply ${g}_{k}\left(x,y,{y}^{\prime}\right)$, where $k$ is given by kgrvcm, $x$ is given by trvcm, ${y}_{i}$ is given by ${\mathbf{y}}\left(i\right)$ and ${y}_{i}^{\prime}$ is given by ${\mathbf{rwork}}\left({\mathbf{yprvcm}}1+i\right)$. The result ${g}_{k}$ should be placed in the variable grvcm.
On final exit: has the value
$0$, which indicates that an output point or root has been reached or an error has occurred (see
ifail).
Note: any values you return to d02qgf as part of the reverse communication procedure should not include floatingpoint NaN (Not a Number) or infinity values, since these are not handled by d02qgf. If your code inadvertently does return any NaNs or infinities, d02qgf is likely to produce unexpected results.
 8: $\mathbf{trvcm}$ – Real (Kind=nag_wp)Output

On intermediate exit:
the current value of the independent variable.
 9: $\mathbf{yrvcm}$ – IntegerOutput

On intermediate exit:
with
${\mathbf{irevcm}}=1$,
$2$,
$3$,
$4$,
$5$,
$6$,
$7$,
$9$,
$10$,
$11$ or
$12$,
yrvcm specifies the locations of the dependent variables
$y$ for use in evaluating the differential system or the event functions.
 ${\mathbf{yrvcm}}=0$
 ${y}_{\mathit{i}}$ is given by ${\mathbf{y}}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$.
 ${\mathbf{yrvcm}}\ne 0$
 ${y}_{\mathit{i}}$ is given by ${\mathbf{rwork}}\left({\mathbf{yrvcm}}+\mathit{i}1\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$.
 10: $\mathbf{yprvcm}$ – IntegerOutput

On intermediate exit:
with
${\mathbf{irevcm}}=1$,
$2$,
$3$,
$4$,
$5$,
$6$ or
$7$,
yprvcm specifies the positions in
rwork at which you should place the derivatives
${y}^{\prime}$.
${y}_{\mathit{i}}^{\prime}$ should be placed in location
${\mathbf{rwork}}\left({\mathbf{yprvcm}}+\mathit{i}1\right)$, for
$\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$.
With
${\mathbf{irevcm}}=9$,
$10$,
$11$ or
$12$,
yprvcm specifies the locations of the derivatives
${y}^{\prime}$ for use in evaluating the event functions.
${y}_{\mathit{i}}^{\prime}$ is given by
${\mathbf{rwork}}\left({\mathbf{yprvcm}}+\mathit{i}1\right)$, for
$\mathit{i}=1,2,\dots ,{\mathbf{neqf}}$.
 11: $\mathbf{grvcm}$ – Real (Kind=nag_wp)Input

On initial entry: need not be set.
On intermediate reentry: with
${\mathbf{irevcm}}=9$,
$10$,
$11$ or
$12$,
grvcm must contain the value of
${g}_{k}\left(x,y,{y}^{\prime}\right)$, where
$k$ is given by
kgrvcm.
 12: $\mathbf{kgrvcm}$ – IntegerInput/Output

On intermediate reentry: with
${\mathbf{irevcm}}=9$,
$10$,
$11$ or
$12$,
kgrvcm must remain unchanged from a previous call to
d02qgf.
On intermediate exit:
with
${\mathbf{irevcm}}=9$,
$10$,
$11$ or
$12$,
kgrvcm specifies which event function
${g}_{k}\left(x,y,{y}^{\prime}\right)$ you must evaluate.
 13: $\mathbf{rwork}\left({\mathbf{lrwork}}\right)$ – Real (Kind=nag_wp) arrayCommunication Array

This
must be the same argument
rwork as supplied to
d02qwf. It is used to pass information from
d02qwf to
d02qgf, and from
d02qgf to
d02qxf,
d02qyf and
d02qzf. Therefore the contents of this array
must not be changed before the call to
d02qgf or calling any of the routines
d02qxf,
d02qyf and
d02qzf.
 14: $\mathbf{lrwork}$ – IntegerInput

On initial entry: the dimension of the array
rwork as declared in the (sub)program from which
d02qgf is called.
This must be the same argument
lrwork as supplied to
d02qwf.
 15: $\mathbf{iwork}\left({\mathbf{liwork}}\right)$ – Integer arrayCommunication Array

This
must be the same argument
iwork as supplied to
d02qwf. It is used to pass information from
d02qwf to
d02qgf, and from
d02qgf to
d02qxf,
d02qyf and
d02qzf. Therefore the contents of this array
must not be changed before the call to
d02qgf or calling any of the routines
d02qxf,
d02qyf and
d02qzf.
 16: $\mathbf{liwork}$ – IntegerInput

On initial entry: the dimension of the array
iwork as declared in the (sub)program from which
d02qgf is called.
This must be the same argument
liwork as supplied to
d02qwf.
 17: $\mathbf{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$

On entry, the integrator detected an illegal input, or
d02qwf has not been called before the call to the integrator.
This error may be caused by overwriting elements of
rwork and
iwork.
 ${\mathbf{ifail}}=2$

The maximum number of steps has been attempted (at a cost of about
$2$ derivative evaluations per step). (See argument
maxstp in
d02qwf.) If integration is to be continued then you need only reset
ifail and call the routine again and a further
maxstp steps will be attempted.
 ${\mathbf{ifail}}=3$

The step size needed to satisfy the error requirements is too small for the
machine precision being used. (See argument
tolfac in
d02qxf.)
 ${\mathbf{ifail}}=4$

Some error weight
${w}_{i}$ became zero during the integration (see arguments
vectol,
rtol and
atol in
d02qwf.) Pure relative error control (
${\mathbf{atol}}=0.0$) was requested on a variable (the
$i$th) which has now become zero. (See argument
badcmp in
d02qxf.) The integration was successful as far as
t.
 ${\mathbf{ifail}}=5$

The problem appears to be stiff (see the
D02 Chapter Introduction for a discussion of the term ‘stiff’). Although it is inefficient to use this integrator to solve stiff problems, integration may be continued by resetting
ifail and calling the routine again.
 ${\mathbf{ifail}}=6$

A change in sign of an event function has been detected but the rootfinding process appears to have converged to a singular point
t rather than a root. Integration may be continued by resetting
ifail and calling the routine again.
 ${\mathbf{ifail}}=7$

The code has detected two successive error exits at the current value of
t and cannot proceed. Check all input variables.
 ${\mathbf{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.
 ${\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
vectol,
rtol and
atol in a prior call to
d02qwf. 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 equation system. The code is designed so that a reduction in the tolerances should lead to an approximately proportional reduction in the error. You are strongly recommended to call
d02qgf with more than one set of tolerances and to compare the results obtained to estimate their accuracy.
The accuracy obtained depends on the type of error test used. If the solution oscillates around zero a relative error test should be avoided, whereas if the solution is exponentially increasing an absolute error test should not be used. If different accuracies are required for different components of the solution then a componentwise error test should be used. For a description of the error test see the specifications of the arguments
vectol,
rtol and
atol in the routine document for
d02qwf.
The accuracy of any roots located will depend on the accuracy of integration and may also be restricted by the numerical properties of $g\left(x,y,{y}^{\prime}\right)$. When evaluating $g$ you should try to write the code so that unnecessary cancellation errors will be avoided.
8
Parallelism and Performance
d02qgf is not thread safe and should not be called from a multithreaded user program. Please see
Section 3.12.1 in How to Use the NAG Library and its Documentation for more information on thread safety.
d02qgf is not threaded in any implementation.
If
d02qgf fails with
${\mathbf{ifail}}={\mathbf{3}}$ then the combination of
atol and
rtol may be so small that a solution cannot be obtained, in which case the routine should be called again with larger values for
rtol and/or
atol (see
d02qwf). If the accuracy requested is really needed then you should consider whether there is a more fundamental difficulty. For example:
(a) 
in the region of a singularity the solution components will usually be of a large magnitude. d02qgf could be used in onestep mode to monitor the size of the solution 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; 
(b) 
for ‘stiff’ equations, where the solution contains rapidly decaying components, the routine will require a very small step size to preserve stability. This will usually be exhibited by excessive computing time and sometimes an error exit with ${\mathbf{ifail}}={\mathbf{3}}$, but usually an error exit with ${\mathbf{ifail}}={\mathbf{2}}$ or ${\mathbf{5}}$. The Adams' methods are not efficient in such cases and you should consider using a routine from the Subchapter D02M–N. A high proportion of failed steps (see argument nfail in d02qxf) may indicate stiffness but there may be other reasons for this phenomenon. 
d02qgf can be used for producing results at short intervals (for example, for graph plotting); you should set
${\mathbf{crit}}=\mathrm{.TRUE.}$ and
tcrit to the last output point required in a prior call to
d02qwf and then set
tout appropriately for each output point in turn in the call to
d02qgf.
10
Example
This example solves the following system (for a projectile)
over an interval
$\left[0.0,10.0\right]$ starting with values
$y=0.5$,
$v=0.5$ and
$\varphi =\pi /5$ using scalar error control (
${\mathbf{vectol}}=\mathrm{.FALSE.}$) until the first point where
$y=0.0$ is encountered.
Also, d02qgf is used to produce output at intervals of $2.0$.
10.1
Program Text
Program Text (d02qgfe.f90)
10.2
Program Data
Program Data (d02qgfe.d)
10.3
Program Results
Program Results (d02qgfe.r)