NAG Library Routine Document
d02tkf
(withdraw_bvp_coll_nlin)
1
Purpose
d02tkf solves a general two-point boundary value problem for a nonlinear mixed order system of ordinary differential equations.
2
Specification
Fortran Interface
Integer, Intent (Inout) | :: |
icomm(*),
ifail | Real (Kind=nag_wp), Intent (Inout) | :: |
rcomm(*) | External | :: |
ffun,
fjac,
gafun,
gbfun,
gajac,
gbjac,
guess |
|
C Header Interface
#include nagmk26.h
void |
d02tkf_ (
void (NAG_CALL *ffun)(
const double *x,
const double y[],
const Integer *neq,
const Integer m[],
double f[]),
void (NAG_CALL *fjac)(
const double *x,
const double y[],
const Integer *neq,
const Integer m[],
double dfdy[]),
void (NAG_CALL *gafun)(
const double ya[],
const Integer *neq,
const Integer m[],
const Integer *nlbc,
double ga[]),
void (NAG_CALL *gbfun)(
const double yb[],
const Integer *neq,
const Integer m[],
const Integer *nrbc,
double gb[]),
void (NAG_CALL *gajac)(
const double ya[],
const Integer *neq,
const Integer m[],
const Integer *nlbc,
double dgady[]),
void (NAG_CALL *gbjac)(
const double yb[],
const Integer *neq,
const Integer m[],
const Integer *nrbc,
double dgbdy[]),
void (NAG_CALL *guess)(
const double *x,
const Integer *neq,
const Integer m[],
double y[],
double dym[]),
double rcomm[],
Integer icomm[],
Integer *ifail) |
|
3
Description
d02tkf and its associated routines (
d02tvf,
d02txf,
d02tyf and
d02tzf) solve the two-point boundary value problem for a nonlinear mixed order system of ordinary differential equations
over an interval
subject to
(
) nonlinear boundary conditions at
and
(
) nonlinear boundary conditions at
, where
. Note that
is the
th derivative of the
th solution component. Hence
. The left boundary conditions at
are defined as
and the right boundary conditions at
as
where
and
First,
d02tvf must be called to specify the initial mesh, error requirements and other details. Note that the error requirements apply only to the solution components
and that no error control is applied to derivatives of solution components. (If error control is required on derivatives then the system must be reduced in order by introducing the derivatives whose error is to be controlled as new variables. See
Section 9 in
d02tvf.) Then,
d02tkf can be used to solve the boundary value problem. After successful computation,
d02tzf can be used to ascertain details about the final mesh and other details of the solution procedure, and
d02tyf can be used to compute the approximate solution anywhere on the interval
.
A description of the numerical technique used in
d02tkf is given in
Section 3 in
d02tvf.
d02tkf can also be used in the solution of a series of problems, for example in performing continuation, when the mesh used to compute the solution of one problem is to be used as the initial mesh for the solution of the next related problem.
d02txf should be used in between calls to
d02tkf in this context.
See
Section 9 in
d02tvf for details of how to solve boundary value problems of a more general nature.
The routines are based on modified versions of the codes COLSYS and COLNEW (see
Ascher et al. (1979) and
Ascher and Bader (1987)). A comprehensive treatment of the numerical solution of boundary value problems can be found in
Ascher et al. (1988) and
Keller (1992).
4
References
Ascher U M and Bader G (1987) A new basis implementation for a mixed order boundary value ODE solver SIAM J. Sci. Stat. Comput. 8 483–500
Ascher U M, Christiansen J and Russell R D (1979) A collocation solver for mixed order systems of boundary value problems Math. Comput. 33 659–679
Ascher U M, Mattheij R M M and Russell R D (1988) Numerical Solution of Boundary Value Problems for Ordinary Differential Equations Prentice–Hall
Keller H B (1992) Numerical Methods for Two-point Boundary-value Problems Dover, New York
5
Arguments
- 1: – Subroutine, supplied by the user.External Procedure
-
ffun must evaluate the functions
for given values
.
The specification of
ffun is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq) | Real (Kind=nag_wp), Intent (In) | :: |
x,
y(neq,) | Real (Kind=nag_wp), Intent (Out) | :: |
f(neq) |
|
C Header Interface
#include nagmk26.h
void |
ffun (
const double *x,
const double y[],
const Integer *neq,
const Integer m[],
double f[]) |
|
- 1: – Real (Kind=nag_wp)Input
-
On entry: , the independent variable.
- 2: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 3: – IntegerInput
-
On entry: the number of differential equations.
- 4: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: must contain , for .
ffun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: ffun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 2: – Subroutine, supplied by the user.External Procedure
-
fjac must evaluate the partial derivatives of
with respect to the elements of
.
The specification of
fjac is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq) | Real (Kind=nag_wp), Intent (In) | :: |
x,
y(neq,) | Real (Kind=nag_wp), Intent (Inout) | :: |
dfdy(neq,neq,) |
|
C Header Interface
#include nagmk26.h
void |
fjac (
const double *x,
const double y[],
const Integer *neq,
const Integer m[],
double dfdy[]) |
|
- 1: – Real (Kind=nag_wp)Input
-
On entry: , the independent variable.
- 2: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 3: – IntegerInput
-
On entry: the number of differential equations.
- 4: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 5: – Real (Kind=nag_wp) arrayInput/Output
-
On entry: set to zero.
On exit: must contain the partial derivative of with respect to , for , and . Only nonzero partial derivatives need be set.
fjac must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: fjac should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 3: – Subroutine, supplied by the user.External Procedure
-
gafun must evaluate the boundary conditions at the left-hand end of the range, that is functions
for given values of
.
The specification of
gafun is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq),
nlbc | Real (Kind=nag_wp), Intent (In) | :: |
ya(neq,) | Real (Kind=nag_wp), Intent (Out) | :: |
ga(nlbc) |
|
C Header Interface
#include nagmk26.h
void |
gafun (
const double ya[],
const Integer *neq,
const Integer m[],
const Integer *nlbc,
double ga[]) |
|
- 1: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 2: – IntegerInput
-
On entry: the number of differential equations.
- 3: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 4: – IntegerInput
-
On entry: the number of boundary conditions at .
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: must contain , for .
gafun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: gafun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 4: – Subroutine, supplied by the user.External Procedure
-
gbfun must evaluate the boundary conditions at the right-hand end of the range, that is functions
for given values of
.
The specification of
gbfun is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq),
nrbc | Real (Kind=nag_wp), Intent (In) | :: |
yb(neq,) | Real (Kind=nag_wp), Intent (Out) | :: |
gb(nrbc) |
|
C Header Interface
#include nagmk26.h
void |
gbfun (
const double yb[],
const Integer *neq,
const Integer m[],
const Integer *nrbc,
double gb[]) |
|
- 1: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 2: – IntegerInput
-
On entry: the number of differential equations.
- 3: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 4: – IntegerInput
-
On entry: the number of boundary conditions at .
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: must contain , for .
gbfun must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: gbfun should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 5: – Subroutine, supplied by the user.External Procedure
-
gajac must evaluate the partial derivatives of
with respect to the elements of
.
The specification of
gajac is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq),
nlbc | Real (Kind=nag_wp), Intent (In) | :: |
ya(neq,) | Real (Kind=nag_wp), Intent (Inout) | :: |
dgady(nlbc,neq,) |
|
C Header Interface
#include nagmk26.h
void |
gajac (
const double ya[],
const Integer *neq,
const Integer m[],
const Integer *nlbc,
double dgady[]) |
|
- 1: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 2: – IntegerInput
-
On entry: the number of differential equations.
- 3: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 4: – IntegerInput
-
On entry: the number of boundary conditions at .
- 5: – Real (Kind=nag_wp) arrayInput/Output
-
On entry: set to zero.
On exit: must contain the partial derivative of with respect to , for , and . Only nonzero partial derivatives need be set.
gajac must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: gajac should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 6: – Subroutine, supplied by the user.External Procedure
-
gbjac must evaluate the partial derivatives of
with respect to the elements of
.
The specification of
gbjac is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq),
nrbc | Real (Kind=nag_wp), Intent (In) | :: |
yb(neq,) | Real (Kind=nag_wp), Intent (Inout) | :: |
dgbdy(nrbc,neq,) |
|
C Header Interface
#include nagmk26.h
void |
gbjac (
const double yb[],
const Integer *neq,
const Integer m[],
const Integer *nrbc,
double dgbdy[]) |
|
- 1: – Real (Kind=nag_wp) arrayInput
-
On entry: contains , for and .
Note: .
- 2: – IntegerInput
-
On entry: the number of differential equations.
- 3: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 4: – IntegerInput
-
On entry: the number of boundary conditions at .
- 5: – Real (Kind=nag_wp) arrayInput/Output
-
On entry: set to zero.
On exit: must contain the partial derivative of with respect to , for , and . Only nonzero partial derivatives need be set.
gbjac must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: gbjac should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 7: – Subroutine, supplied by the user.External Procedure
-
guess must return initial approximations for the solution components
and the derivatives
, for
and
. Try to compute each derivative
such that it corresponds to your approximations to
, for
. You should
not call
ffun to compute
.
If
d02tkf is being used in conjunction with
d02txf as part of a continuation process,
guess is not called by
d02tkf after the call to
d02txf.
The specification of
guess is:
Fortran Interface
Integer, Intent (In) | :: |
neq,
m(neq) | Real (Kind=nag_wp), Intent (In) | :: |
x | Real (Kind=nag_wp), Intent (Inout) | :: |
y(neq,) | Real (Kind=nag_wp), Intent (Out) | :: |
dym(neq) |
|
C Header Interface
#include nagmk26.h
void |
guess (
const double *x,
const Integer *neq,
const Integer m[],
double y[],
double dym[]) |
|
- 1: – Real (Kind=nag_wp)Input
-
On entry: , the independent variable; .
- 2: – IntegerInput
-
On entry: the number of differential equations.
- 3: – Integer arrayInput
-
On entry:
contains , the order of the th differential equation, for .
- 4: – Real (Kind=nag_wp) arrayOutput
-
On exit: must contain , for and .
Note: .
- 5: – Real (Kind=nag_wp) arrayOutput
-
On exit: must contain , for .
guess must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which
d02tkf is called. Arguments denoted as
Input must
not be changed by this procedure.
Note: guess should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by
d02tkf. If your code inadvertently
does return any NaNs or infinities,
d02tkf is likely to produce unexpected results.
- 8: – Real (Kind=nag_wp) arrayCommunication Array
-
On entry: this must be the same array as supplied to
d02tvf and
must remain unchanged between calls.
On exit: contains information about the solution for use on subsequent calls to associated routines.
- 9: – Integer arrayCommunication Array
-
On entry: this must be the same array as supplied to
d02tvf and
must remain unchanged between calls.
On exit: contains information about the solution for use on subsequent calls to associated routines.
- 10: – IntegerInput/Output
-
On entry:
ifail must be set to
,
. 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
is recommended. If the output of error messages is undesirable, then the value
is recommended. Otherwise, because for this routine the values of the output arguments may be useful even if
on exit, the recommended value is
.
When the value is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Note: d02tkf may return useful information for one or more of the following detected errors or warnings.
Errors or warnings detected by the routine:
-
On entry, an invalid call was made to
d02tkf, for example, without a previous call to the setup routine
d02tvf.
-
Numerical singularity has been detected in the Jacobian used in the underlying Newton iteration. No meaningful results have been computed. You should check carefully how you have coded
fjac,
gajac and
gbjac. If the user-supplied routines have been coded correctly then supplying a different initial approximation to the solution in
guess might be appropriate. See also
Section 9.
-
The nonlinear iteration has failed to converge. At no time during the computation was convergence obtained and no meaningful results have been computed. You should check carefully how you have coded procedures
fjac,
gajac and
gbjac. If the procedures have been coded correctly then supplying a better initial approximation to the solution in
guess might be appropriate. See also
Section 9.
-
The nonlinear iteration has failed to converge. At some earlier time during the computation convergence was obtained and the corresponding results have been returned for diagnostic purposes and may be inspected by a call to
d02tzf. Nothing can be said regarding the suitability of these results for use in any subsequent computation for the same problem. You should try to provide a better mesh and initial approximation to the solution in
guess. See also
Section 9.
-
The expected number of sub-intervals required exceeds the maximum number specified by the argument
mxmesh in the setup routine
d02tvf. Results for the last mesh on which convergence was obtained have been returned. Nothing can be said regarding the suitability of these results for use in any subsequent computation for the same problem. An indication of the error in the solution on the last mesh where convergence was obtained can be obtained by calling
d02tzf. The error requirements may need to be relaxed and/or the maximum number of mesh points may need to be increased. See also
Section 9.
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.
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.
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 the solution is determined by the argument
tols in the prior call to
d02tvf (see
Sections 3 and
9 in
d02tvf for details and advice). Note that error control is applied only to solution components (variables) and not to any derivatives of the solution. An estimate of the maximum error in the computed solution is available by calling
d02tzf.
8
Parallelism and Performance
d02tkf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
d02tkf 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 d02tkf returns with , , or and the call to d02tkf was a part of some continuation procedure for which successful calls to d02tkf have already been made, then it is possible that the adjustment(s) to the continuation argument(s) between calls to d02tkf is (are) too large for the problem under consideration. More conservative adjustment(s) to the continuation argument(s) might be appropriate.
10
Example
The following example is used to illustrate the treatment of a high-order system, control of the error in a derivative of a component of the original system, and the use of continuation. See also
d02tvf,
d02txf,
d02tyf and
d02tzf, for the illustration of other facilities.
Consider the steady flow of an incompressible viscous fluid between two infinite coaxial rotating discs. See
Ascher et al. (1979) and the references therein. The governing equations are
subject to the boundary conditions
where
is the Reynolds number and
are the angular velocities of the disks.
We consider the case of counter-rotation and a symmetric solution, that is
. This problem is more difficult to solve, the larger the value of
. For illustration, we use simple continuation to compute the solution for three different values of
(
). However, this problem can be addressed directly for the largest value of
considered here. Instead of the values suggested in
Section 5 in
d02txf for
nmesh,
ipmesh and
mesh in the call to
d02txf prior to a continuation call, we use every point of the final mesh for the solution of the first value of
, that is we must modify the contents of
ipmesh. For illustrative purposes we wish to control the computed error in
and so recast the equations as
subject to the boundary conditions
For the symmetric boundary conditions considered, there exists an odd solution about
. Hence, to satisfy the boundary conditions, we use the following initial approximations to the solution in
guess:
10.1
Program Text
Program Text (d02tkfe.f90)
10.2
Program Data
Program Data (d02tkfe.d)
10.3
Program Results
Program Results (d02tkfe.r)