NAG Library Routine Document
D03PJF/D03PJA
1 Purpose
D03PJF/D03PJA integrates a system of linear or nonlinear parabolic partial differential equations (PDEs), in one space variable with scope for coupled ordinary differential equations (ODEs). The spatial discretization is performed using a Chebyshev collocation method, and the method of lines is employed to reduce the PDEs to a system of ODEs. The resulting system is solved using a backward differentiation formula (BDF) method or a Theta method (switching between Newton's method and functional iteration).
D03PJA is a version of D03PJF that has additional parameters in order to make it safe for use in multithreaded applications (see
Section 5).
2 Specification
2.1 Specification for D03PJF
SUBROUTINE D03PJF ( |
NPDE, M, TS, TOUT, PDEDEF, BNDARY, U, NBKPTS, XBKPTS, NPOLY, NPTS, X, NCODE, ODEDEF, NXI, XI, NEQN, UVINIT, RTOL, ATOL, ITOL, NORM, LAOPT, ALGOPT, RSAVE, LRSAVE, ISAVE, LISAVE, ITASK, ITRACE, IND, IFAIL) |
INTEGER |
NPDE, M, NBKPTS, NPOLY, NPTS, NCODE, NXI, NEQN, ITOL, LRSAVE, ISAVE(LISAVE), LISAVE, ITASK, ITRACE, IND, IFAIL |
REAL (KIND=nag_wp) |
TS, TOUT, U(NEQN), XBKPTS(NBKPTS), X(NPTS), XI(*), RTOL(*), ATOL(*), ALGOPT(30), RSAVE(LRSAVE) |
CHARACTER(1) |
NORM, LAOPT |
EXTERNAL |
PDEDEF, BNDARY, ODEDEF, UVINIT |
|
2.2 Specification for D03PJA
SUBROUTINE D03PJA ( |
NPDE, M, TS, TOUT, PDEDEF, BNDARY, U, NBKPTS, XBKPTS, NPOLY, NPTS, X, NCODE, ODEDEF, NXI, XI, NEQN, UVINIT, RTOL, ATOL, ITOL, NORM, LAOPT, ALGOPT, RSAVE, LRSAVE, ISAVE, LISAVE, ITASK, ITRACE, IND, IUSER, RUSER, CWSAV, LWSAV, IWSAV, RWSAV, IFAIL) |
INTEGER |
NPDE, M, NBKPTS, NPOLY, NPTS, NCODE, NXI, NEQN, ITOL, LRSAVE, ISAVE(LISAVE), LISAVE, ITASK, ITRACE, IND, IUSER(*), IWSAV(505), IFAIL |
REAL (KIND=nag_wp) |
TS, TOUT, U(NEQN), XBKPTS(NBKPTS), X(NPTS), XI(*), RTOL(*), ATOL(*), ALGOPT(30), RSAVE(LRSAVE), RUSER(*), RWSAV(1100) |
LOGICAL |
LWSAV(100) |
CHARACTER(1) |
NORM, LAOPT |
CHARACTER(80) |
CWSAV(10) |
EXTERNAL |
PDEDEF, BNDARY, ODEDEF, UVINIT |
|
3 Description
D03PJF/D03PJA integrates the system of parabolic-elliptic equations and coupled ODEs
where
(1) defines the PDE part and
(2) generalizes the coupled ODE part of the problem.
In
(1),
and
depend on
,
,
,
, and
;
depends on
,
,
,
,
and
linearly on
. The vector
is the set of PDE solution values
and the vector
is the partial derivative with respect to
. Note that
,
and
must not depend on
. The vector
is the set of ODE solution values
and
denotes its derivative with respect to time.
In
(2),
represents a vector of
spatial coupling points at which the ODEs are coupled to the PDEs. These points may or may not be equal to some of the PDE spatial mesh points.
,
,
,
and
are the functions
,
,
,
and
evaluated at these coupling points. Each
may only depend linearly on time derivatives. Hence the equation
(2) may be written more precisely as
where
,
is a vector of length
NCODE,
is an
NCODE by
NCODE matrix,
is an
NCODE by
matrix and the entries in
,
and
may depend on
,
,
,
and
. In practice you need only supply a vector of information to define the ODEs and not the matrices
and
. (See
Section 5 for the specification of
ODEDEF.)
The integration in time is from to , over the space interval , where and are the leftmost and rightmost of a user-defined set of break points . The coordinate system in space is defined by the value of ; for Cartesian coordinates, for cylindrical polar coordinates and for spherical polar coordinates.
The PDE system which is defined by the functions
,
and
must be specified in
PDEDEF.
The initial values of the functions
and
must be given at
. These values are calculated in
UVINIT.
The functions
which may be thought of as fluxes, are also used in the definition of the boundary conditions. The boundary conditions must have the form
where
or
. The functions
may only depend
linearly on
.
The boundary conditions must be specified in
BNDARY.
The algebraic-differential equation system which is defined by the functions
must be specified in
ODEDEF. You must also specify the coupling points
in the array
XI. Thus, the problem is subject to the following restrictions:
(i) |
in (1), , for , may only appear linearly in the functions
, for , with a similar restriction for ; |
(ii) |
and the flux must not depend on any time derivatives; |
(iii) |
, so that integration is in the forward direction; |
(iv) |
the evaluation of the functions , and is done at both the break points and internally selected points for each element in turn, that is , and are evaluated twice at each break point. Any discontinuities in these functions must therefore be at one or more of the mesh points; |
(v) |
at least one of the functions must be nonzero so that there is a time derivative present in the PDE problem; |
(vi) |
if and , which is the left boundary point, then it must be ensured that the PDE solution is bounded at this point. This can be done either by specifying the solution at or by specifying a zero flux there, that is and . |
The parabolic equations are approximated by a system of ODEs in time for the values of
at the mesh points. This ODE system is obtained by approximating the PDE solution between each pair of break points by a Chebyshev polynomial of degree
NPOLY. The interval between each pair of break points is treated by D03PJF/D03PJA as an element, and on this element, a polynomial and its space and time derivatives are made to satisfy the system of PDEs at
spatial points, which are chosen internally by the code and the break points. The user-defined break points and the internally selected points together define the mesh. The smallest value that
NPOLY can take is one, in which case, the solution is approximated by piecewise linear polynomials between consecutive break points and the method is similar to an ordinary finite element method.
In total there are
mesh points in the spatial direction, and
ODEs in the time direction; one ODE at each break point for each PDE component,
ODEs for each PDE component between each pair of break points, and
NCODE coupled ODEs. The system is then integrated forwards in time using a Backward Differentiation Formula (BDF) method or a Theta method.
4 References
Berzins M (1990) Developments in the NAG Library software for parabolic equations Scientific Software Systems (eds J C Mason and M G Cox) 59–72 Chapman and Hall
Berzins M and Dew P M (1991) Algorithm 690: Chebyshev polynomial software for elliptic-parabolic systems of PDEs ACM Trans. Math. Software 17 178–206
Berzins M, Dew P M and Furzeland R M (1988) Software tools for time-dependent equations in simulation and optimization of large systems Proc. IMA Conf. Simulation and Optimization (ed A J Osiadcz) 35–50 Clarendon Press, Oxford
Berzins M and Furzeland R M (1992) An adaptive theta method for the solution of stiff and nonstiff differential equations Appl. Numer. Math. 9 1–19
Zaturska N B, Drazin P G and Banks W H H (1988) On the flow of a viscous fluid driven along a channel by a suction at porous walls Fluid Dynamics Research 4
5 Parameters
- 1: NPDE – INTEGERInput
On entry: the number of PDEs to be solved.
Constraint:
.
- 2: M – INTEGERInput
On entry: the coordinate system used:
- Indicates Cartesian coordinates.
- Indicates cylindrical polar coordinates.
- Indicates spherical polar coordinates.
Constraint:
, or .
- 3: TS – REAL (KIND=nag_wp)Input/Output
On entry: the initial value of the independent variable .
On exit: the value of
corresponding to the solution values in
U. Normally
.
Constraint:
.
- 4: TOUT – REAL (KIND=nag_wp)Input
On entry: the final value of to which the integration is to be carried out.
- 5: PDEDEF – SUBROUTINE, supplied by the user.External Procedure
PDEDEF must compute the functions
,
and
which define the system of PDEs. The functions may depend on
,
,
,
and
;
may depend linearly on
. The functions must be evaluated at a set of points.
The specification of
PDEDEF
for D03PJF is:
SUBROUTINE PDEDEF ( |
NPDE, T, X, NPTL, U, UX, NCODE, V, VDOT, P, Q, R, IRES) |
INTEGER |
NPDE, NPTL, NCODE, IRES |
REAL (KIND=nag_wp) |
T, X(NPTL), U(NPDE,NPTL), UX(NPDE,NPTL), V(NCODE), VDOT(NCODE), P(NPDE,NPDE,NPTL), Q(NPDE,NPTL), R(NPDE,NPTL) |
|
The specification of
PDEDEF
for D03PJA is:
SUBROUTINE PDEDEF ( |
NPDE, T, X, NPTL, U, UX, NCODE, V, VDOT, P, Q, R, IRES, IUSER, RUSER) |
INTEGER |
NPDE, NPTL, NCODE, IRES, IUSER(*) |
REAL (KIND=nag_wp) |
T, X(NPTL), U(NPDE,NPTL), UX(NPDE,NPTL), V(NCODE), VDOT(NCODE), P(NPDE,NPDE,NPTL), Q(NPDE,NPTL), R(NPDE,NPTL), RUSER(*) |
|
- 1: NPDE – INTEGERInput
On entry: the number of PDEs in the system.
- 2: T – REAL (KIND=nag_wp)Input
On entry: the current value of the independent variable .
- 3: X(NPTL) – REAL (KIND=nag_wp) arrayInput
On entry: contains a set of mesh points at which , and are to be evaluated. and contain successive user-supplied break points and the elements of the array will satisfy .
- 4: NPTL – INTEGERInput
On entry: the number of points at which evaluations are required (the value of ).
- 5: U(NPDE,NPTL) – REAL (KIND=nag_wp) arrayInput
On entry: contains the value of the component where , for and .
- 6: UX(NPDE,NPTL) – REAL (KIND=nag_wp) arrayInput
On entry: contains the value of the component where , for and .
- 7: NCODE – INTEGERInput
On entry: the number of coupled ODEs in the system.
- 8: V(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of the component , for .
- 9: VDOT(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if
,
contains the value of component
, for
.
Note:
, for , may only appear linearly in
, for .
- 10: P(NPDE,NPDE,NPTL) – REAL (KIND=nag_wp) arrayOutput
On exit: must be set to the value of where , for , and .
- 11: Q(NPDE,NPTL) – REAL (KIND=nag_wp) arrayOutput
On exit: must be set to the value of where , for and .
- 12: R(NPDE,NPTL) – REAL (KIND=nag_wp) arrayOutput
On exit: must be set to the value of where , for and .
- 13: IRES – INTEGERInput/Output
On entry: set to .
On exit: should usually remain unchanged. However, you may set
IRES to force the integration routine to take certain actions as described below:
- Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to .
- Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set when a physically meaningless input or output value has been generated. If you consecutively set , then D03PJF/D03PJA returns to the calling subroutine with the error indicator set to .
- Note: the following are additional parameters for specific use with D03PJA. Users of D03PJF therefore need not read the remainder of this description.
- 14: IUSER() – INTEGER arrayUser Workspace
- 15: RUSER() – REAL (KIND=nag_wp) arrayUser Workspace
-
PDEDEF is called with the parameters
IUSER and
RUSER as supplied to D03PJF/D03PJA. You are free to use the arrays
IUSER and
RUSER to supply information to
PDEDEF as an alternative to using COMMON global variables.
PDEDEF must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PJF/D03PJA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 6: BNDARY – SUBROUTINE, supplied by the user.External Procedure
BNDARY must compute the functions
and
which define the boundary conditions as in equation
(4).
The specification of
BNDARY
for D03PJF is:
SUBROUTINE BNDARY ( |
NPDE, T, U, UX, NCODE, V, VDOT, IBND, BETA, GAMMA, IRES) |
INTEGER |
NPDE, NCODE, IBND, IRES |
REAL (KIND=nag_wp) |
T, U(NPDE), UX(NPDE), V(NCODE), VDOT(NCODE), BETA(NPDE), GAMMA(NPDE) |
|
The specification of
BNDARY
for D03PJA is:
SUBROUTINE BNDARY ( |
NPDE, T, U, UX, NCODE, V, VDOT, IBND, BETA, GAMMA, IRES, IUSER, RUSER) |
INTEGER |
NPDE, NCODE, IBND, IRES, IUSER(*) |
REAL (KIND=nag_wp) |
T, U(NPDE), UX(NPDE), V(NCODE), VDOT(NCODE), BETA(NPDE), GAMMA(NPDE), RUSER(*) |
|
- 1: NPDE – INTEGERInput
On entry: the number of PDEs in the system.
- 2: T – REAL (KIND=nag_wp)Input
On entry: the current value of the independent variable .
- 3: U(NPDE) – REAL (KIND=nag_wp) arrayInput
On entry:
contains the value of the component
at the boundary specified by
IBND, for
.
- 4: UX(NPDE) – REAL (KIND=nag_wp) arrayInput
On entry:
contains the value of the component
at the boundary specified by
IBND, for
.
- 5: NCODE – INTEGERInput
On entry: the number of coupled ODEs in the system.
- 6: V(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of the component , for .
- 7: VDOT(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if
,
contains the value of component
, for
.
Note:
, for , may only appear linearly in
, for .
- 8: IBND – INTEGERInput
On entry: specifies which boundary conditions are to be evaluated.
- BNDARY must set up the coefficients of the left-hand boundary, .
- BNDARY must set up the coefficients of the right-hand boundary, .
- 9: BETA(NPDE) – REAL (KIND=nag_wp) arrayOutput
On exit:
must be set to the value of
at the boundary specified by
IBND, for
.
- 10: GAMMA(NPDE) – REAL (KIND=nag_wp) arrayOutput
On exit:
must be set to the value of
at the boundary specified by
IBND, for
.
- 11: IRES – INTEGERInput/Output
On entry: set to .
On exit: should usually remain unchanged. However, you may set
IRES to force the integration routine to take certain actions as described below:
- Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to .
- Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set when a physically meaningless input or output value has been generated. If you consecutively set , then D03PJF/D03PJA returns to the calling subroutine with the error indicator set to .
- Note: the following are additional parameters for specific use with D03PJA. Users of D03PJF therefore need not read the remainder of this description.
- 12: IUSER() – INTEGER arrayUser Workspace
- 13: RUSER() – REAL (KIND=nag_wp) arrayUser Workspace
-
BNDARY is called with the parameters
IUSER and
RUSER as supplied to D03PJF/D03PJA. You are free to use the arrays
IUSER and
RUSER to supply information to
BNDARY as an alternative to using COMMON global variables.
BNDARY must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PJF/D03PJA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 7: U(NEQN) – REAL (KIND=nag_wp) arrayInput/Output
On entry: if
the value of
U must be unchanged from the previous call.
On exit: the computed solution
, for
and
, and
, for
, evaluated at
, as follows:
-
contain , for and , and
-
contain , for .
- 8: NBKPTS – INTEGERInput
On entry: the number of break points in the interval .
Constraint:
.
- 9: XBKPTS(NBKPTS) – REAL (KIND=nag_wp) arrayInput
On entry: the values of the break points in the space direction. must specify the left-hand boundary, , and must specify the right-hand boundary, .
Constraint:
.
- 10: NPOLY – INTEGERInput
On entry: the degree of the Chebyshev polynomial to be used in approximating the PDE solution between each pair of break points.
Constraint:
.
- 11: NPTS – INTEGERInput
On entry: the number of mesh points in the interval .
Constraint:
.
- 12: X(NPTS) – REAL (KIND=nag_wp) arrayOutput
On exit: the mesh points chosen by D03PJF/D03PJA in the spatial direction. The values of
X will satisfy
.
- 13: NCODE – INTEGERInput
On entry: the number of coupled ODE components.
Constraint:
.
- 14: ODEDEF – SUBROUTINE, supplied by the NAG Library or the user.External Procedure
ODEDEF must evaluate the functions
, which define the system of ODEs, as given in
(3).
If you wish to compute the solution of a system of PDEs only (
),
ODEDEF must be the dummy routine D03PCK/D53PCK for D03PJF (or D53PCK for D03PJA). D03PCK/D53PCK and D53PCK are included in the NAG Library.
The specification of
ODEDEF
for D03PJF is:
SUBROUTINE ODEDEF ( |
NPDE, T, NCODE, V, VDOT, NXI, XI, UCP, UCPX, RCP, UCPT, UCPTX, F, IRES) |
INTEGER |
NPDE, NCODE, NXI, IRES |
REAL (KIND=nag_wp) |
T, V(NCODE), VDOT(NCODE), XI(NXI), UCP(NPDE,*), UCPX(NPDE,*), RCP(NPDE,*), UCPT(NPDE,*), UCPTX(NPDE,*), F(NCODE) |
|
The specification of
ODEDEF
for D03PJA is:
SUBROUTINE ODEDEF ( |
NPDE, T, NCODE, V, VDOT, NXI, XI, UCP, UCPX, RCP, UCPT, UCPTX, F, IRES, IUSER, RUSER) |
INTEGER |
NPDE, NCODE, NXI, IRES, IUSER(*) |
REAL (KIND=nag_wp) |
T, V(NCODE), VDOT(NCODE), XI(NXI), UCP(NPDE,*), UCPX(NPDE,*), RCP(NPDE,*), UCPT(NPDE,*), UCPTX(NPDE,*), F(NCODE), RUSER(*) |
|
- 1: NPDE – INTEGERInput
On entry: the number of PDEs in the system.
- 2: T – REAL (KIND=nag_wp)Input
On entry: the current value of the independent variable .
- 3: NCODE – INTEGERInput
On entry: the number of coupled ODEs in the system.
- 4: V(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of the component , for .
- 5: VDOT(NCODE) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of component , for .
- 6: NXI – INTEGERInput
On entry: the number of ODE/PDE coupling points.
- 7: XI(NXI) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the ODE/PDE coupling points, , for .
- 8: UCP(NPDE,) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of at the coupling point , for and .
- 9: UCPX(NPDE,) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of at the coupling point , for and .
- 10: RCP(NPDE,) – REAL (KIND=nag_wp) arrayInput
On entry: contains the value of the flux at the coupling point , for and .
- 11: UCPT(NPDE,) – REAL (KIND=nag_wp) arrayInput
On entry: if , contains the value of at the coupling point , for and .
- 12: UCPTX(NPDE,) – REAL (KIND=nag_wp) arrayInput
On entry: contains the value of at the coupling point , for and .
- 13: F(NCODE) – REAL (KIND=nag_wp) arrayOutput
On exit:
must contain the
th component of
, for
, where
is defined as
or
The definition of
is determined by the input value of
IRES.
- 14: IRES – INTEGERInput/Output
On entry: the form of
that must be returned in the array
F.
- Equation (5) must be used.
- Equation (6) must be used.
On exit: should usually remain unchanged. However, you may reset
IRES to force the integration routine to take certain actions as described below:
- Indicates to the integrator that control should be passed back immediately to the calling (sub)routine with the error indicator set to .
- Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set when a physically meaningless input or output value has been generated. If you consecutively set , then D03PJF/D03PJA returns to the calling subroutine with the error indicator set to .
- Note: the following are additional parameters for specific use with D03PJA. Users of D03PJF therefore need not read the remainder of this description.
- 15: IUSER() – INTEGER arrayUser Workspace
- 16: RUSER() – REAL (KIND=nag_wp) arrayUser Workspace
-
ODEDEF is called with the parameters
IUSER and
RUSER as supplied to D03PJF/D03PJA. You are free to use the arrays
IUSER and
RUSER to supply information to
ODEDEF as an alternative to using COMMON global variables.
ODEDEF must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PJF/D03PJA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 15: NXI – INTEGERInput
On entry: the number of ODE/PDE coupling points.
Constraints:
- if , ;
- if , .
- 16: XI() – REAL (KIND=nag_wp) arrayInput
-
Note: the dimension of the array
XI
must be at least
.
On entry: , for , must be set to the ODE/PDE coupling points.
Constraint:
.
- 17: NEQN – INTEGERInput
On entry: the number of ODEs in the time direction.
Constraint:
.
- 18: UVINIT – SUBROUTINE, supplied by the user.External Procedure
UVINIT must compute the initial values of the PDE and the ODE components
, for
and
, and
, for
.
The specification of
UVINIT
for D03PJF is:
INTEGER |
NPDE, NPTS, NCODE |
REAL (KIND=nag_wp) |
X(NPTS), U(NPDE,NPTS), V(NCODE) |
|
The specification of
UVINIT
for D03PJA is:
INTEGER |
NPDE, NPTS, NCODE, IUSER(*) |
REAL (KIND=nag_wp) |
X(NPTS), U(NPDE,NPTS), V(NCODE), RUSER(*) |
|
- 1: NPDE – INTEGERInput
On entry: the number of PDEs in the system.
- 2: NPTS – INTEGERInput
On entry: the number of mesh points in the interval .
- 3: X(NPTS) – REAL (KIND=nag_wp) arrayInput
On entry: , for , contains the current values of the space variable .
- 4: U(NPDE,NPTS) – REAL (KIND=nag_wp) arrayOutput
On exit: if , contains the value of the component , for and .
- 5: NCODE – INTEGERInput
On entry: the number of coupled ODEs in the system.
- 6: V(NCODE) – REAL (KIND=nag_wp) arrayOutput
On exit: contains the value of component , for .
- Note: the following are additional parameters for specific use with D03PJA. Users of D03PJF therefore need not read the remainder of this description.
- 7: IUSER() – INTEGER arrayUser Workspace
- 8: RUSER() – REAL (KIND=nag_wp) arrayUser Workspace
-
UVINIT is called with the parameters
IUSER and
RUSER as supplied to D03PJF/D03PJA. You are free to use the arrays
IUSER and
RUSER to supply information to
UVINIT as an alternative to using COMMON global variables.
UVINIT must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PJF/D03PJA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 19: RTOL() – REAL (KIND=nag_wp) arrayInput
-
Note: the dimension of the array
RTOL
must be at least
if
or
and at least
if
or
.
On entry: the relative local error tolerance.
Constraint:
for all relevant .
- 20: ATOL() – REAL (KIND=nag_wp) arrayInput
-
Note: the dimension of the array
ATOL
must be at least
if
or
and at least
if
or
.
On entry: the absolute local error tolerance.
Constraint:
for all relevant
.
Note: corresponding elements of
RTOL and
ATOL cannot both be
.
- 21: ITOL – INTEGERInput
On entry: a value to indicate the form of the local error test.
ITOL indicates to D03PJF/D03PJA whether to interpret either or both of
RTOL or
ATOL as a vector or scalar. The error test to be satisfied is
, where
is defined as follows:
ITOL | RTOL | ATOL | |
1 | scalar | scalar | |
2 | scalar | vector | |
3 | vector | scalar | |
4 | vector | vector | |
In the above, denotes the estimated local error for the th component of the coupled PDE/ODE system in time, , for .
The choice of norm used is defined by the parameter
NORM.
Constraint:
.
- 22: NORM – CHARACTER(1)Input
On entry: the type of norm to be used.
- Maximum norm.
- Averaged norm.
If
denotes the norm of the vector
U of length
NEQN, then for the averaged
norm
while for the maximum norm
See the description of
ITOL for the formulation of the weight vector
.
Constraint:
or .
- 23: LAOPT – CHARACTER(1)Input
On entry: the type of matrix algebra required.
- Full matrix methods to be used.
- Banded matrix methods to be used.
- Sparse matrix methods to be used.
Constraint:
, or .
Note: you are recommended to use the banded option when no coupled ODEs are present (i.e., ).
- 24: ALGOPT() – REAL (KIND=nag_wp) arrayInput
On entry: may be set to control various options available in the integrator. If you wish to employ all the default options, then
should be set to
. Default values will also be used for any other elements of
ALGOPT set to zero. The permissible values, default values, and meanings are as follows:
- Selects the ODE integration method to be used. If , a BDF method is used and if , a Theta method is used. The default value is .
If , then
, for are not used.
- Specifies the maximum order of the BDF integration formula to be used. may be , , , or . The default value is .
- Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the BDF method. If a modified Newton iteration is used and if a functional iteration method is used. If functional iteration is selected and the integrator encounters difficulty, then there is an automatic switch to the modified Newton iteration. The default value is .
- Specifies whether or not the Petzold error test is to be employed. The Petzold error test results in extra overhead but is more suitable when algebraic equations are present, such as
, for , for some or when there is no dependence in the coupled ODE system. If , then the Petzold test is used. If , then the Petzold test is not used. The default value is .
If , then
, for , are not used.
- Specifies the value of Theta to be used in the Theta integration method. . The default value is .
- Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the Theta method. If , a modified Newton iteration is used and if , a functional iteration method is used. The default value is .
- Specifies whether or not the integrator is allowed to switch automatically between modified Newton and functional iteration methods in order to be more efficient. If , then switching is allowed and if , then switching is not allowed. The default value is .
- Specifies a point in the time direction, , beyond which integration must not be attempted. The use of is described under the parameter ITASK. If , a value of for , say, should be specified even if ITASK subsequently specifies that will not be used.
- Specifies the minimum absolute step size to be allowed in the time integration. If this option is not required, should be set to .
- Specifies the maximum absolute step size to be allowed in the time integration. If this option is not required, should be set to .
- Specifies the initial step size to be attempted by the integrator. If , then the initial step size is calculated internally.
- Specifies the maximum number of steps to be attempted by the integrator in any one call. If , then no limit is imposed.
- Specifies what method is to be used to solve the nonlinear equations at the initial point to initialize the values of , , and . If , a modified Newton iteration is used and if , functional iteration is used. The default value is .
and are used only for the sparse matrix algebra option, .
- Governs the choice of pivots during the decomposition of the first Jacobian matrix. It should lie in the range , with smaller values biasing the algorithm towards maintaining sparsity at the expense of numerical stability. If lies outside this range then the default value is used. If the routines regard the Jacobian matrix as numerically singular then increasing towards may help, but at the cost of increased fill-in. The default value is .
- Is used as a relative pivot threshold during subsequent Jacobian decompositions (see ) below which an internal error is invoked. If is greater than no check is made on the pivot size, and this may be a necessary option if the Jacobian is found to be numerically singular (see ). The default value is .
- 25: RSAVE(LRSAVE) – REAL (KIND=nag_wp) arrayCommunication Array
If
,
RSAVE need not be set on entry.
If
,
RSAVE must be unchanged from the previous call to the routine because it contains required information about the iteration.
- 26: LRSAVE – INTEGERInput
On entry: the dimension of the array
RSAVE as declared in the (sub)program from which D03PJF/D03PJA is called.
Its size depends on the type of matrix algebra selected.
If , .
If , .
If , .
Where
|
is the lower or upper half bandwidths such that , for PDE problems only (no coupled ODEs); or , for coupled PDE/ODE problems. |
|
|
|
|
Note: when
, the value of
LRSAVE may be too small when supplied to the integrator. An estimate of the minimum size of
LRSAVE is printed on the current error message unit if
and the routine returns with
.
- 27: ISAVE(LISAVE) – INTEGER arrayCommunication Array
If
,
ISAVE need not be set on entry.
If
,
ISAVE must be unchanged from the previous call to the routine because it contains required information about the iteration required for subsequent calls. In particular:
- Contains the number of steps taken in time.
- Contains the number of residual evaluations of the resulting ODE system used. One such evaluation involves computing the PDE functions at all the mesh points, as well as one evaluation of the functions in the boundary conditions.
- Contains the number of Jacobian evaluations performed by the time integrator.
- Contains the order of the ODE method last used in the time integration.
- Contains the number of Newton iterations performed by the time integrator. Each iteration involves residual evaluation of the resulting ODE system followed by a back-substitution using the decomposition of the Jacobian matrix.
- 28: LISAVE – INTEGERInput
On entry: the dimension of the array
ISAVE as declared in the (sub)program from which D03PJF/D03PJA is called. Its size depends on the type of matrix algebra selected:
- if , ;
- if , ;
- if , .
Note: when using the sparse option, the value of
LISAVE may be too small when supplied to the integrator. An estimate of the minimum size of
LISAVE is printed on the current error message unit if
and the routine returns with
.
- 29: ITASK – INTEGERInput
On entry: specifies the task to be performed by the ODE integrator.
- Normal computation of output values U at .
- One step and return.
- Stop at first internal integration point at or beyond .
- Normal computation of output values U at but without overshooting where is described under the parameter ALGOPT.
- Take one step in the time direction and return, without passing , where is described under the parameter ALGOPT.
Constraint:
, , , or .
- 30: ITRACE – INTEGERInput
On entry: the level of trace information required from D03PJF/D03PJA and the underlying ODE solver.
ITRACE may take the value
,
,
,
or
.
- No output is generated.
- Only warning messages from the PDE solver are printed on the current error message unit (see X04AAF).
- Output from the underlying ODE solver is printed on the current advisory message unit (see X04ABF). This output contains details of Jacobian entries, the nonlinear iteration and the time integration during the computation of the ODE system.
If , then is assumed and similarly if , then is assumed.
The advisory messages are given in greater detail as
ITRACE increases. You are advised to set
, unless you are experienced with
sub-chapter D02M–N.
- 31: IND – INTEGERInput/Output
On entry: indicates whether this is a continuation call or a new integration.
- Starts or restarts the integration in time.
- Continues the integration after an earlier exit from the routine. In this case, only the parameters TOUT and IFAIL should be reset between calls to D03PJF/D03PJA.
Constraint:
or .
On exit: .
- 32: IFAIL – INTEGERInput/Output
-
Note: for D03PJA, IFAIL does not occur in this position in the parameter list. See the additional parameters described below.
On entry:
IFAIL must be set to
,
. If you are unfamiliar with this parameter you should refer to
Section 3.3 in the Essential Introduction 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, if you are not familiar with this parameter, 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).
- Note: the following are additional parameters for specific use with D03PJA. Users of D03PJF therefore need not read the remainder of this description.
- 32: IUSER() – INTEGER arrayUser Workspace
- 33: RUSER() – REAL (KIND=nag_wp) arrayUser Workspace
-
IUSER and
RUSER are not used by D03PJF/D03PJA, but are passed directly to
PDEDEF,
BNDARY,
ODEDEF and
UVINIT and may be used to pass information to these routines as an alternative to using COMMON global variables.
- 34: CWSAV() – CHARACTER(80) arrayCommunication Array
- 35: LWSAV() – LOGICAL arrayCommunication Array
- 36: IWSAV() – INTEGER arrayCommunication Array
- 37: RWSAV() – REAL (KIND=nag_wp) arrayCommunication Array
- 38: IFAIL – INTEGERInput/Output
Note: see the parameter description for
IFAIL above.
6 Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
X04AAF).
Errors or warnings detected by the routine:
On entry, | is too small, |
or | , , , or , |
or | , or , |
or | at least one of the coupling point in array XI is outside the interval [], |
or | , |
or | , |
or | , |
or | or , |
or | , , or , |
or | or , |
or | NCODE and NXI are incorrectly defined, |
or | , |
or | , or , |
or | or , |
or | break points are badly ordered, |
or | LRSAVE is too small, |
or | LISAVE is too small, |
or | the ODE integrator has not been correctly defined; check ALGOPT parameter, |
or | either an element of RTOL or , |
or | all the elements of RTOL and ATOL are zero. |
-
The underlying ODE solver cannot make any further progress, with the values of
ATOL and
RTOL, across the integration range from the current point
. The components of
U contain the computed values at the current point
.
-
In the underlying ODE solver, there were repeated error test failures on an attempted step, before completing the requested task, but the integration was successful as far as . The problem may have a singularity, or the error requirement may be inappropriate.
-
In setting up the ODE system, the internal initialization routine was unable to initialize the derivative of the ODE system. This could be due to the fact that
IRES was repeatedly set to
in at least
PDEDEF,
BNDARY or
ODEDEF, when the residual in the underlying ODE solver was being evaluated.
-
In solving the ODE system, a singular Jacobian has been encountered. You should check your problem formulation.
-
When evaluating the residual in solving the ODE system,
IRES was set to
in at least
PDEDEF,
BNDARY or
ODEDEF. Integration was successful as far as
.
-
The values of
ATOL and
RTOL are so small that the routine is unable to start the integration in time.
-
In one of
PDEDEF,
BNDARY or
ODEDEF,
IRES was set to an invalid value.
- (D02NNF)
-
A serious error has occurred in an internal call to the specified routine. Check the problem specification and all parameters and array dimensions. Setting
may provide more information. If the problem persists, contact
NAG.
-
The required task has been completed, but it is estimated that a small change in
ATOL and
RTOL is unlikely to produce any change in the computed solution. (Only applies when you are not operating in one step mode, that is when
or
.)
-
An error occurred during Jacobian formulation of the ODE system (a more detailed error description may be directed to the current error message unit).
-
In solving the ODE system, the maximum number of steps specified in have been taken.
-
Some error weights
became zero during the time integration (see the description of
ITOL). Pure relative error control (
) was requested on a variable (the
th) which has become zero. The integration was successful as far as
.
-
The flux function was detected as depending on time derivatives, which is not permissible.
-
When using the sparse option, the value of
LISAVE or
LRSAVE was not sufficient (more detailed information may be directed to the current error message unit).
7 Accuracy
D03PJF/D03PJA controls the accuracy of the integration in the time direction but not the accuracy of the approximation in space. The spatial accuracy depends on both the number of mesh points and on their distribution in space. In the time integration only the local error over a single step is controlled and so the accuracy over a number of steps cannot be guaranteed. You should therefore test the effect of varying the accuracy parameter
ATOL and
RTOL.
The parameter specification allows you to include equations with only first-order derivatives in the space direction but there is no guarantee that the method of integration will be satisfactory for such systems. The position and nature of the boundary conditions in particular are critical in defining a stable problem.
The time taken depends on the complexity of the parabolic system and on the accuracy requested.
9 Example
This example provides a simple coupled system of one PDE and one ODE.
for
.
The left boundary condition at
is
The right boundary condition at
is
The initial conditions at
are defined by the exact solution:
and the coupling point is at
.
9.1 Program Text
Note: the following programs illustrate the use of D03PJF and D03PJA.
Program Text (d03pjfe.f90)
Program Text (d03pjae.f90)
9.2 Program Data
Program Data (d03pjfe.d)
Program Data (d03pjae.d)
9.3 Program Results
Program Results (d03pjfe.r)
Program Results (d03pjae.r)