NAG Library Function Document
nag_ode_ivp_adams_gen (d02cjc)
1
Purpose
nag_ode_ivp_adams_gen (d02cjc) integrates a system of first order ordinary differential equations over a range with suitable initial conditions, using a variable-order, variable-step Adams' method until a user-specified function, if supplied, of the solution is zero, and returns the solution at specified points, if desired.
2
Specification
#include <nag.h> |
#include <nagd02.h> |
void |
nag_ode_ivp_adams_gen (Integer neq,
void |
(*fcn)(Integer neq,
double x,
const double y[],
double f[],
Nag_User *comm),
|
|
double *x,
double y[],
double xend,
double tol,
Nag_ErrorControl err_c,
double |
(*g)(Integer neq,
double x,
const double y[],
Nag_User *comm),
|
|
Nag_User *comm,
NagError *fail) |
|
3
Description
nag_ode_ivp_adams_gen (d02cjc) advances the solution of a system of ordinary differential equations
from
to
using a variable-order, variable-step Adams' method. The system is defined by
fcn, which evaluates
in terms of
and
. The initial values of
must be given at
.
The solution is returned via
output at specified points, if desired: this solution is obtained by
interpolation on solution values produced by the method. As the integration proceeds a check can be made on the user-specified function
to determine an interval where it changes sign. The position of this sign change is then determined accurately. It is assumed that
is a continuous function of the variables, so that a solution of
can be determined by searching for a change in sign in
. The accuracy of the integration, the interpolation and, indirectly, of the determination of the position where
, is controlled by the arguments
tol and
err_c.
For a description of Adams' methods and their practical implementation see
Hall and Watt (1976).
4
References
Hall G and Watt J M (ed.) (1976) Modern Numerical Methods for Ordinary Differential Equations Clarendon Press, Oxford
5
Arguments
- 1:
– IntegerInput
-
On entry: the number of differential equations.
Constraint:
.
- 2:
– function, supplied by the userExternal Function
-
fcn must evaluate the first derivatives
(i.e., the functions
) for given values of their arguments
.
The specification of
fcn is:
void |
fcn (Integer neq,
double x,
const double y[],
double f[],
Nag_User *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of differential equations.
- 2:
– doubleInput
-
On entry: the value of the independent variable .
- 3:
– const doubleInput
-
On entry: holds the value of the variable , for .
- 4:
– doubleOutput
-
On exit: must contain the value of , for .
- 5:
– Nag_User *
-
Pointer to a structure of type Nag_User with the following member:
- p – Pointer
-
On entry/exit: the pointer
should be cast to the required type, e.g.,
struct user *s = (struct user *)comm → p, to obtain the original object's address with appropriate type. (See the argument
comm below.)
Note: fcn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
nag_ode_ivp_adams_gen (d02cjc). If your code inadvertently
does return any NaNs or infinities,
nag_ode_ivp_adams_gen (d02cjc) is likely to produce unexpected results.
- 3:
– double *Input/Output
-
On entry: the initial value of the independent variable .
Constraint:
.
On exit: if
is supplied,
x contains the point where
, unless
anywhere on the range
x to
xend, in which case,
x will contain
xend. If
is not supplied
x contains
xend, unless an error has occurred, when it contains the value of
at the error.
- 4:
– doubleInput/Output
-
On entry: the initial values of the solution at .
On exit: the computed values of the solution at the final point .
- 5:
– doubleInput
-
On entry: the final value of the independent variable.
- Integration proceeds in the negative direction.
Constraint:
.
- 6:
– doubleInput
-
On entry: a positive tolerance for controlling the error in the integration. Hence
tol affects the determination of the position where
, if
is supplied.
nag_ode_ivp_adams_gen (d02cjc) 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
nag_ode_ivp_adams_gen (d02cjc) 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
nag_ode_ivp_adams_gen (d02cjc) with
and
where
correct decimal digits are required in the solution.
Constraint:
.
- 7:
– Nag_ErrorControlInput
-
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:
where
and
are defined by
where
is a small machine-dependent number and
is an estimate of the local error at
, computed internally. If the appropriate 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
err_c should be set to
on entry, whereas if the error requirement is in terms of the number of correct significant digits, then
err_c should be set to
. If you prefer a mixed error test, then
err_c should be set to
. The recommended value for
err_c is
and this should be chosen unless there are good reasons for a different choice.
Constraint:
, or .
- 8:
– function, supplied by the userExternal Function
-
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
nag_ode_ivp_adams_gen (d02cjc) with
(the initial value of
). 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,
nag_ode_ivp_adams_gen (d02cjc) will integrate to
xend with no further calls to
output; if a call to
output is required at the point
, then
xsol must be given precisely the value
xend.
The specification of
output is:
void |
output (Integer neq,
double *xsol,
const double y[],
Nag_User *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of differential equations.
- 2:
– double *Input/Output
-
On entry: the value of the independent variable .
On exit: you must set
xsol to the next value of
at which
output is to be called.
- 3:
– const doubleInput
-
On entry: the computed solution at the point
xsol.
- 4:
– Nag_User *
-
Pointer to a structure of type Nag_User with the following member:
- p – Pointer
-
On entry/exit: the pointer
should be cast to the required type, e.g.,
struct user *s = (struct user *)comm → p, to obtain the original object's address with appropriate type. (See the argument
comm below.)
Note: output should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
nag_ode_ivp_adams_gen (d02cjc). If your code inadvertently
does return any NaNs or infinities,
nag_ode_ivp_adams_gen (d02cjc) is likely to produce unexpected results.
If you do not wish to access intermediate output, the actual argument
output must be the NAG defined null function pointer
NULLFN.
- 9:
– function, supplied by the userExternal Function
-
g must evaluate
for specified values
. It specifies the function
for which the first position
where
is to be found.
The specification of
g is:
double |
g (Integer neq,
double x,
const double y[],
Nag_User *comm)
|
|
- 1:
– IntegerInput
-
On entry: the number of differential equations.
- 2:
– doubleInput
-
On entry: the value of the independent variable .
- 3:
– const doubleInput
-
On entry: holds the value of the variable , for .
- 4:
– Nag_User *
-
Pointer to a structure of type Nag_User with the following member:
- p – Pointer
-
On entry/exit: the pointer
should be cast to the required type, e.g.,
struct user *s = (struct user *)comm → p, to obtain the original object's address with appropriate type. (See the argument
comm below.)
Note: g should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
nag_ode_ivp_adams_gen (d02cjc). If your code inadvertently
does return any NaNs or infinities,
nag_ode_ivp_adams_gen (d02cjc) is likely to produce unexpected results.
If you do not require the root finding option, the actual argument
g must be the NAG defined null double function pointer
NULLDFN.
- 10:
– Nag_User *
-
Pointer to a structure of type Nag_User with the following member:
- p – Pointer
-
On entry/exit: the pointer
, of type Pointer, allows you to communicate information to and from
fcn,
output and
g. An object of the required type should be declared, e.g., a structure, and its address assigned to the pointer
by means of a cast to Pointer in the calling program. E.g.
comm.p = (Pointer)&s. The type pointer will be
void * with a C compiler that defines
void * and
char * otherwise.
- 11:
– NagError *Input/Output
-
The NAG error argument (see
Section 3.7 in How to Use the NAG Library and its Documentation).
6
Error Indicators and Warnings
- NE_2_REAL_ARG_EQ
-
On entry, while . These arguments must satisfy .
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
- NE_BAD_PARAM
-
On entry, argument
err_c had an illegal value.
- NE_INT_ARG_LT
-
On entry, .
Constraint: .
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
- NE_NO_SIGN_CHANGE
-
No change in sign of the function was detected in the integration range.
- NE_REAL_ARG_LE
-
On entry,
tol must not be less than or equal to 0.0:
.
- NE_TOL_PROGRESS
-
The value of
tol,
, is too small for the function to make any further progress across the integration range. Current value of
.
- NE_TOL_TOO_SMALL
-
The value of
tol,
, is too small for the function to take an initial step.
- NE_XSOL_INCONSIST
-
On call
to the supplied print function
xsol was set to a value behind the previous value of
xsol in the direction of integration.
Previous
,
, new
.
- NE_XSOL_NOT_RESET
-
On call
to the supplied print function
xsol was not reset.
- NE_XSOL_SET_WRONG
-
xsol was set to a value behind
x in the direction of integration by the first call to the supplied print function.
The integration range is
,
.
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
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
. You should try to code
g without introducing any unnecessary cancellation errors.
8
Parallelism and Performance
nag_ode_ivp_adams_gen (d02cjc) is not threaded in any implementation.
If more than one root is required then
nag_ode_ivp_adams_roots (d02qfc) should be used.
If the function fails with error exit of
, 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 function, the system may be very stiff (see below) or so badly scaled that it cannot be solved to the required accuracy.
If the function fails with error exit of
, 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 function will usually stop with error exit of , 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 function will use very small steps in (internally to nag_ode_ivp_adams_gen (d02cjc)) to preserve stability. This will exhibit itself by making the computing time excessively long, or occasionally by an exit with . Adams' methods are not efficient in such cases. |
10
Example
We illustrate the solution of four different problems. In each case the differential system (for a projectile) is
over an interval
to
starting with values
,
and
. We solve each of the following problems with local error tolerances
and
.
(i) |
To integrate to producing output at intervals of 2.0 until a point is encountered where . |
(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 (d02cjce.c)
10.2
Program Data
None.
10.3
Program Results
Program Results (d02cjce.r)