NAG FL Interface
d02raf (bvp_​fd_​nonlin_​gen)

1 Purpose

d02raf solves a two-point boundary value problem with general boundary conditions for a system of ordinary differential equations, using a deferred correction technique and Newton iteration.

2 Specification

Fortran Interface
Subroutine d02raf ( n, mnp, np, numbeg, nummix, tol, init, x, y, ldy, abt, fcn, g, ijac, jacobf, jacobg, deleps, jaceps, jacgep, work, lwork, iwork, liwork, ifail)
Integer, Intent (In) :: n, mnp, numbeg, nummix, init, ldy, ijac, lwork, liwork
Integer, Intent (Inout) :: np, ifail
Integer, Intent (Out) :: iwork(liwork)
Real (Kind=nag_wp), Intent (In) :: tol
Real (Kind=nag_wp), Intent (Inout) :: x(mnp), y(ldy,mnp), deleps
Real (Kind=nag_wp), Intent (Out) :: abt(n), work(lwork)
External :: fcn, g, jacobf, jacobg, jaceps, jacgep
C Header Interface
#include <nag.h>
void  d02raf_ (const Integer *n, const Integer *mnp, Integer *np, const Integer *numbeg, const Integer *nummix, const double *tol, const Integer *init, double x[], double y[], const Integer *ldy, double abt[],
void (NAG_CALL *fcn)(const double *x, const double *eps, const double y[], double f[], const Integer *n),
void (NAG_CALL *g)(const double *eps, const double ya[], const double yb[], double bc[], const Integer *n),
const Integer *ijac,
void (NAG_CALL *jacobf)(const double *x, const double *eps, const double y[], double f[], const Integer *n),
void (NAG_CALL *jacobg)(const double *eps, const double ya[], const double yb[], double aj[], double bj[], const Integer *n),
double *deleps,
void (NAG_CALL *jaceps)(const double *x, const double *eps, const double y[], double f[], const Integer *n),
void (NAG_CALL *jacgep)(const double *eps, const double ya[], const double yb[], double bcep[], const Integer *n),
double work[], const Integer *lwork, Integer iwork[], const Integer *liwork, Integer *ifail)
The routine may be called by the names d02raf or nagf_ode_bvp_fd_nonlin_gen.

3 Description

d02raf solves a two-point boundary value problem for a system of n ordinary differential equations in the interval a,b with b>a. The system is written in the form
yi = f i x, y 1 , y 2 ,, y n ,   i=1,2,,n (1)
and the derivatives fi are evaluated by fcn. With the differential equations (1) must be given a system of n (nonlinear) boundary conditions
gi ya,yb = 0 ,   i=1,2,,n ,  
where
y x = y 1 x , y 2 x ,, y n x T . (2)
The functions gi are evaluated by g. The solution is computed using a finite difference technique with deferred correction allied to a Newton iteration to solve the finite difference equations. The technique used is described fully in Pereyra (1979).
You must supply an absolute error tolerance and may also supply an initial mesh for the finite difference equations and an initial approximate solution (alternatively a default mesh and approximation are used). The approximate solution is corrected using Newton iteration and deferred correction. Then, additional points are added to the mesh and the solution is recomputed with the aim of making the error everywhere less than your tolerance and of approximately equidistributing the error on the final mesh. The solution is returned on this final mesh.
If the solution is required at a few specific points then these should be included in the initial mesh. If, on the other hand, the solution is required at several specific points then you should use the interpolation routines provided in Chapter E01 if these points do not themselves form a convenient mesh.
The Newton iteration requires Jacobian matrices
fi yj , gi yja  and  gi yjb .  
These may be supplied through jacobf for fi yj and jacobg for the others. Alternatively the Jacobians may be calculated by numerical differentiation using the algorithm described in Curtis et al. (1974).
For problems of the type (1) and (2) for which it is difficult to determine an initial approximation from which the Newton iteration will converge, a continuation facility is provided. You must set up a family of problems
y = f x,y,ε ,   g ya,yb,ε = 0 , (3)
where f = f 1 , f 2 ,, f n T etc., and where ε is a continuation parameter. The choice ε=0 must give a problem (3) which is easy to solve and ε=1 must define the problem whose solution is actually required. The routine solves a sequence of problems with ε values
0 = ε1 < ε2 < < εp = 1 . (4)
The number p and the values εi are chosen by the routine so that each problem can be solved using the solution of its predecessor as a starting approximation. Jacobians f ε and g ε are required and they may be supplied by you via jaceps and jacgep respectively or may be computed by numerical differentiation.

4 References

Curtis A R, Powell M J D and Reid J K (1974) On the estimation of sparse Jacobian matrices J. Inst. Maths. Applics. 13 117–119
Pereyra V (1979) PASVA3: An adaptive finite-difference Fortran program for first order nonlinear, ordinary boundary problems Codes for Boundary Value Problems in Ordinary Differential Equations. Lecture Notes in Computer Science (eds B Childs, M Scott, J W Daniel, E Denman and P Nelson) 76 Springer–Verlag

5 Arguments

1: n Integer Input
On entry: n, the number of differential equations.
Constraint: n>0.
2: mnp Integer Input
On entry: mnp must be set to the maximum permitted number of points in the finite difference mesh. If lwork or liwork are too small then internally mnp will be replaced by the maximum permitted by these values. (A warning message will be output if on entry ifail is set to obtain monitoring information.)
Constraint: mnp32.
3: np Integer Input/Output
On entry: must be set to the number of points to be used in the initial mesh.
Constraint: 4npmnp.
On exit: the number of points in the final mesh.
4: numbeg Integer Input
On entry: the number of left-hand boundary conditions (that is the number involving ya only).
Constraint: 0numbeg<n.
5: nummix Integer Input
On entry: the number of coupled boundary conditions (that is the number involving both ya and yb).
Constraint: 0nummixn-numbeg.
6: tol Real (Kind=nag_wp) Input
On entry: a positive absolute error tolerance. If
a=x1<x2<<xnp=b  
is the final mesh, zjxi is the jth component of the approximate solution at xi, and yjx is the jth component of the true solution of (1) and (2), then, except in extreme circumstances, it is expected that
zjxi-yjxitol,  i=1,2,,np​ and ​j=1,2,,n. (5)
Constraint: tol>0.0.
7: init Integer Input
On entry: indicates whether you wish to supply an initial mesh and approximate solution (init=1) or whether default values are to be used, (init=0).
Constraint: init=0 or 1.
8: xmnp Real (Kind=nag_wp) array Input/Output
On entry: you must set x1=a and xnp=b. If init=0 on entry a default equispaced mesh will be used, otherwise you must specify a mesh by setting xi=xi, for i=2,3,,np-1.
Constraints:
  • if init=0, x1<xnp;
  • if init=1, x1<x2<<xnp.
On exit: x1,x2,,xnp define the final mesh (with the returned value of np) and x1=a and xnp=b.
9: yldymnp Real (Kind=nag_wp) array Input/Output
On entry: if init=0, y need not be set.
If init=1, the array y must contain an initial approximation to the solution such that yji contains an approximation to
yjxi,  i=1,2,,np​ and ​j=1,2,,n.  
On exit: the approximate solution zjxi satisfying (5) on the final mesh, that is
yji=zjxi,  i=1,2,,np​ and ​j=1,2,,n,  
where np is the number of points in the final mesh. If an error has occurred then y contains the latest approximation to the solution. The remaining columns of y are not used.
10: ldy Integer Input
On entry: the first dimension of the array y as declared in the (sub)program from which d02raf is called.
Constraint: ldyn.
11: abtn Real (Kind=nag_wp) array Output
On exit: abti, for i=1,2,,n, holds the largest estimated error (in magnitude) of the ith component of the solution over all mesh points.
12: fcn Subroutine, supplied by the user. External Procedure
fcn must evaluate the functions fi (i.e., the derivatives yi) at a general point x for a given value of ε, the continuation parameter (see Section 3).
The specification of fcn is:
Fortran Interface
Subroutine fcn ( x, eps, y, f, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: x, eps, y(n)
Real (Kind=nag_wp), Intent (Out) :: f(n)
C Header Interface
void  fcn_ (const double *x, const double *eps, const double y[], double f[], const Integer *n)
1: x Real (Kind=nag_wp) Input
On entry: x, the value of the independent variable.
2: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter. This is 1 if continuation is not being used.
3: yn Real (Kind=nag_wp) array Input
On entry: yi, for i=1,2,,n, the values of the dependent variables at x.
4: fn Real (Kind=nag_wp) array Output
On exit: the values of the derivatives fi evaluated at x given ε, for i=1,2,,n.
5: n Integer Input
On entry: n, the number of equations.
fcn must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: fcn should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
13: g Subroutine, supplied by the user. External Procedure
g must evaluate the boundary conditions in equation (3) and place them in the array bc.
The specification of g is:
Fortran Interface
Subroutine g ( eps, ya, yb, bc, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: eps, ya(n), yb(n)
Real (Kind=nag_wp), Intent (Out) :: bc(n)
C Header Interface
void  g_ (const double *eps, const double ya[], const double yb[], double bc[], const Integer *n)
1: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter. This is 1 if continuation is not being used.
2: yan Real (Kind=nag_wp) array Input
On entry: the value yia, for i=1,2,,n.
3: ybn Real (Kind=nag_wp) array Input
On entry: the value yib, for i=1,2,,n.
4: bcn Real (Kind=nag_wp) array Output
On exit: the values gi ya,yb,ε , for i=1,2,,n. These must be ordered as follows:
  1. (i)first, the conditions involving only ya (see numbeg);
  2. (ii)next, the nummix coupled conditions involving both ya and yb (see nummix); and,
  3. (iii)finally, the conditions involving only yb (n-numbeg-nummix).
5: n Integer Input
On entry: n, the number of equations.
g must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: g should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
14: ijac Integer Input
On entry: indicates whether or not you are supplying Jacobian evaluation routines.
ijac0
You must supply jacobf and jacobg and also, when continuation is used, jaceps and jacgep.
ijac=0
Numerical differentiation is used to calculate the Jacobian and the routines d02gaw, d02gax, d02gay and d02gaz respectively may be used as the dummy arguments.
15: jacobf Subroutine, supplied by the NAG Library or the user. External Procedure
jacobf evaluates the Jacobian fi yj , for i=1,2,,n and j=1,2,,n, given x and yj, for j=1,2,,n.
If ijac=0, numerical differentiation is used to calculate the Jacobian and the routine d02gaz may be substituted for this argument.
The specification of jacobf is:
Fortran Interface
Subroutine jacobf ( x, eps, y, f, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: x, eps, y(n)
Real (Kind=nag_wp), Intent (Out) :: f(n,n)
C Header Interface
void  jacobf_ (const double *x, const double *eps, const double y[], double f[], const Integer *n)
1: x Real (Kind=nag_wp) Input
On entry: x, the value of the independent variable.
2: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter. This is 1 if continuation is not being used.
3: yn Real (Kind=nag_wp) array Input
On entry: yi, for i=1,2,,n, the values of the dependent variables at x.
4: fnn Real (Kind=nag_wp) array Output
On exit: fji must be set to the value of fi yj , evaluated at the point x,y, for i=1,2,,n and j=1,2,,n.
5: n Integer Input
On entry: n, the number of equations.
jacobf must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: jacobf should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
16: jacobg Subroutine, supplied by the NAG Library or the user. External Procedure
jacobg evaluates the Jacobians gi yja and gi yjb . The ordering of the rows of aj and bj must correspond to the ordering of the boundary conditions described in the specification of g.
If ijac=0, numerical differentiation is used to calculate the Jacobian and the routine d02gay may be substituted for this argument.
The specification of jacobg is:
Fortran Interface
Subroutine jacobg ( eps, ya, yb, aj, bj, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: eps, ya(n), yb(n)
Real (Kind=nag_wp), Intent (Out) :: aj(n,n), bj(n,n)
C Header Interface
void  jacobg_ (const double *eps, const double ya[], const double yb[], double aj[], double bj[], const Integer *n)
1: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter. This is 1 if continuation is not being used.
2: yan Real (Kind=nag_wp) array Input
On entry: the value yia, for i=1,2,,n.
3: ybn Real (Kind=nag_wp) array Input
On entry: the value yib, for i=1,2,,n.
4: ajnn Real (Kind=nag_wp) array Output
On exit: ajij must be set to the value gi yja , for i=1,2,,n and j=1,2,,n.
5: bjnn Real (Kind=nag_wp) array Output
On exit: bjij must be set to the value gi yjb , for i=1,2,,n and j=1,2,,n.
6: n Integer Input
On entry: n, the number of equations.
jacobg must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: jacobg should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
17: deleps Real (Kind=nag_wp) Input/Output
On entry: must be given a value which specifies whether continuation is required. If deleps0.0 or deleps1.0 then it is assumed that continuation is not required. If 0.0<deleps<1.0 then it is assumed that continuation is required unless deleps<machine precision when an error exit is taken. deleps is used as the increment ε2-ε1 (see (4)) and the choice deleps=0.1 is recommended.
On exit: an overestimate of the increment εp-εp-1 (in fact the value of the increment which would have been tried if the restriction εp=1 had not been imposed). If continuation was not requested then deleps=0.0.
If continuation is not requested then jaceps and jacgep may each be replaced by dummy actual arguments in the call to d02raf. (d02gaw and d02gax respectively may be used as the dummy arguments.)
18: jaceps Subroutine, supplied by the NAG Library or the user. External Procedure
jaceps evaluates the derivative fi ε given x and y if continuation is being used.
If all Jacobians (derivatives) are to be approximated internally by numerical differentiation, or continuation is not being used, the routine d02gaw may be substituted for this argument.
The specification of jaceps is:
Fortran Interface
Subroutine jaceps ( x, eps, y, f, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: x, eps, y(n)
Real (Kind=nag_wp), Intent (Out) :: f(n)
C Header Interface
void  jaceps_ (const double *x, const double *eps, const double y[], double f[], const Integer *n)
1: x Real (Kind=nag_wp) Input
On entry: x, the value of the independent variable.
2: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter.
3: yn Real (Kind=nag_wp) array Input
On entry: the solution values yi, for i=1,2,,n, at the point x.
4: fn Real (Kind=nag_wp) array Output
On exit: fi must contain the value fi ε at the point x,y, for i=1,2,,n.
5: n Integer Input
On entry: n, the number of equations.
jaceps must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: jaceps should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
19: jacgep Subroutine, supplied by the NAG Library or the user. External Procedure
jacgep evaluates the derivatives gi ε if continuation is being used.
If all Jacobians (derivatives) are to be approximated internally by numerical differentiation, or continuation is not being used, the routine d02gax may be substituted for this argument.
The specification of jacgep is:
Fortran Interface
Subroutine jacgep ( eps, ya, yb, bcep, n)
Integer, Intent (In) :: n
Real (Kind=nag_wp), Intent (In) :: eps, ya(n), yb(n)
Real (Kind=nag_wp), Intent (Out) :: bcep(n)
C Header Interface
void  jacgep_ (const double *eps, const double ya[], const double yb[], double bcep[], const Integer *n)
1: eps Real (Kind=nag_wp) Input
On entry: ε, the value of the continuation parameter.
2: yan Real (Kind=nag_wp) array Input
On entry: the value of yia, for i=1,2,,n.
3: ybn Real (Kind=nag_wp) array Input
On entry: the value of yib, for i=1,2,,n.
4: bcepn Real (Kind=nag_wp) array Output
On exit: bcepi must contain the value of gi ε , for i=1,2,,n.
5: n Integer Input
On entry: n, the number of equations.
jacgep must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d02raf is called. Arguments denoted as Input must not be changed by this procedure.
Note: jacgep should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d02raf. If your code inadvertently does return any NaNs or infinities, d02raf is likely to produce unexpected results.
20: worklwork Real (Kind=nag_wp) array Workspace
21: lwork Integer Input
On entry: the dimension of the array work as declared in the (sub)program from which d02raf is called.
Constraint: lworkmnp×3n2+6n+2+4n2+3n.
22: iworkliwork Integer array Workspace
23: liwork Integer Input
On entry: the dimension of the array iwork as declared in the (sub)program from which d02raf is called.
Constraints:
  • if ijac0, liworkmnp×2×n+1+n;
  • if ijac=0, liworkmnp×2×n+1+n2+4×n+2.
24: ifail Integer Input/Output
This routine uses an ifail input value codification that differs from the normal case to distinguish between errors and warnings (see Section 4 in the Introduction to the NAG Library FL Interface).
On entry: ifail must be set to one of the values below to set behaviour on detection of an error; these values have no effect when no error is detected. The behaviour relate to whether or not program execution is halted and whether or not messages are printed when an error or warning is detected.
ifail Execution Error Printing Warning Printed
000 halted No No
001 continue No No
010 halted Yes No
011 continue Yes No
100 halted No Yes
101 continue No Yes
110 halted Yes Yes
111 continue Yes Yes
For environments where it might be inappropriate to halt program execution when an error is detected, the value 1, 11, 101 or 111 is recommended. If the printing of messages is undesirable, then the value 1 is recommended. Otherwise, the recommended value is 110. When the value 1, 11, 101 or 111 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, liwork=value.
Constraint: liworkvalue.
On entry, lwork=value.
Constraint: lworkmaxnp,32×3×n2+6×n+2+4×n2+3×n; that is, value.
On entry, mnp=value.
Constraint: mnp32.
On entry, n=value.
Constraint: n1.
On entry, np=value.
Constraint: np4.
On entry, np=value and mnp=value.
Constraint: npmnp.
On entry, numbeg=value, nummix=value and n=value.
Constraint: numbeg+nummixn.
On entry, numbeg=value.
Constraint: numbeg0.
On entry, numbeg=value and n=value.
Constraint: numbeg<n.
On entry, nummix=value.
Constraint: nummix0.
On entry, tol=value.
Constraint: tol>0.0.
On entry, x1=value and xnp=value.
Constraint: x1<xnp.
On entry the mesh points are not in strictly ascending order.
For i=value, mesh point i=value, but mesh point i+1=value.
ifail=2
A finer mesh is required for the accuracy requested; that is, mnp=value is not large enough.
ifail=3
The Newton iteration has failed to converge.
This could be due to there being too few points in the initial mesh or to the initial approximate solution being too inaccurate.
If this latter reason is suspected or you cannot make changes to prevent this error, you should use the routine with a continuation facility instead.
ifail=4
Newton iteration has reached round-off level.
If desired accuracy has not been reached, tol is too small for this problem and this machine precision.
ifail=5
The Jacobian for the boundary conditions is singular.
This may occur due to faulty coding of the Jacobian or, in some circumstances, to a zero initial choice of approximate solution.
ifail=6
There is no dependence on the continuation parameter when continuation is being used. This can be due to faulty coding of derivatives with respect to the continuation parameter or to a zero initial choice of approximate solution.
ifail=7
The continuation step is required to be less than machine precision for continuation to proceed. It is likely that either the problem has no solution for some value of the continuation parameter near the current value or that the problem is so difficult that even with continuation it is unlikely to be solved using this routine. In the latter case using more mesh points initially may help.
ifail=8
A serious error occurred in a call to the internal integrator.
The error code internally was value.
Please contact NAG.
ifail=9
A continuation error occurred, but continuation is not being used.
Please contact NAG.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

The solution returned by the routine will be accurate to your tolerance as defined by the relation (5) except in extreme circumstances. The final error estimate over the whole mesh for each component is given in the array abt. If too many points are specified in the initial mesh, the solution may be more accurate than requested and the error may not be approximately equidistributed.

8 Parallelism and Performance

d02raf is not thread safe and should not be called from a multithreaded user program. Please see Section 1 in FL Interface Multithreading for more information on thread safety.
d02raf 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

There are too many factors present to quantify the timing. The time taken by d02raf is negligible only on very simple problems.
You are strongly recommended to set ifail to obtain self-explanatory error messages, and also monitoring information about the course of the computation. Monitoring information is written to a logical advisory message unit which normally default to the same unit number as the error message unit (see Section 5 in the Introduction to the NAG Library FL Interface for details); the advisory message unit number can be changed by calling x04abf.
In the case where you wish to solve a sequence of similar problems, the use of the final mesh and solution from one case as the initial mesh is strongly recommended for the next.

10 Example

This example solves the differential equation
y=-yy-2ε1-y2  
with ε=1 and boundary conditions
y0=y0=0,  y10=1  
to an accuracy specified by tol=1.0E−4. The continuation facility is used with the continuation parameter ε introduced as in the differential equation above and with deleps=0.1 initially. (The continuation facility is not needed for this problem and is used here for illustration.)

10.1 Program Text

Program Text (d02rafe.f90)

10.2 Program Data

Program Data (d02rafe.d)

10.3 Program Results

Program Results (d02rafe.r)
GnuplotProduced by GNUPLOT 4.6 patchlevel 3 0 2 4 6 8 10 0 2 4 6 8 10 0 0.2 0.4 0.6 0.8 1 1.2 1.4 1.6 1.8 y y' and y'' x Example Program Solution of Third-order BVP y y' y'' gnuplot_plot_1 gnuplot_plot_2 gnuplot_plot_3