NAG Library Routine Document
D03PDF/D03PDA
1 Purpose
D03PDF/D03PDA integrates a system of linear or nonlinear parabolic partial differential equations (PDEs) in one space variable. 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 ordinary differential equations (ODEs). The resulting system is solved using a backward differentiation formula method.
D03PDA is a version of D03PDF that has additional parameters in order to make it safe for use in multithreaded applications (see
Section 5).
2 Specification
2.1 Specification for D03PDF
SUBROUTINE D03PDF ( |
NPDE, M, TS, TOUT, PDEDEF, BNDARY, U, NBKPTS, XBKPTS, NPOLY, NPTS, X, UINIT, ACC, RSAVE, LRSAVE, ISAVE, LISAVE, ITASK, ITRACE, IND, IFAIL) |
INTEGER |
NPDE, M, NBKPTS, NPOLY, NPTS, LRSAVE, ISAVE(LISAVE), LISAVE, ITASK, ITRACE, IND, IFAIL |
REAL (KIND=nag_wp) |
TS, TOUT, U(NPDE,NPTS), XBKPTS(NBKPTS), X(NPTS), ACC, RSAVE(LRSAVE) |
EXTERNAL |
PDEDEF, BNDARY, UINIT |
|
2.2 Specification for D03PDA
SUBROUTINE D03PDA ( |
NPDE, M, TS, TOUT, PDEDEF, BNDARY, U, NBKPTS, XBKPTS, NPOLY, NPTS, X, UINIT, ACC, RSAVE, LRSAVE, ISAVE, LISAVE, ITASK, ITRACE, IND, IUSER, RUSER, CWSAV, LWSAV, IWSAV, RWSAV, IFAIL) |
INTEGER |
NPDE, M, NBKPTS, NPOLY, NPTS, LRSAVE, ISAVE(LISAVE), LISAVE, ITASK, ITRACE, IND, IUSER(*), IWSAV(505), IFAIL |
REAL (KIND=nag_wp) |
TS, TOUT, U(NPDE,NPTS), XBKPTS(NBKPTS), X(NPTS), ACC, RSAVE(LRSAVE), RUSER(*), RWSAV(1100) |
LOGICAL |
LWSAV(100) |
CHARACTER(80) |
CWSAV(10) |
EXTERNAL |
PDEDEF, BNDARY, UINIT |
|
3 Description
D03PDF/D03PDA integrates the system of parabolic equations:
where
,
and
depend on
,
,
,
and the vector
is the set of solution values
and the vector
is its partial derivative with respect to
. Note that
,
and
must not depend on
.
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 system is defined by the functions
,
and
which must be specified in
PDEDEF.
The initial values of the functions
must be given at
, and must be specified in
UINIT.
The functions
, for
, which may be thought of as fluxes, are also used in the definition of the boundary conditions for each equation. The boundary conditions must have the form
where
or
.
The boundary conditions must be specified in
BNDARY. Thus, the problem is subject to the following restrictions:
(i) |
, so that integration is in the forward direction; |
(ii) |
, and the flux must not depend on any time derivatives; |
(iii) |
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 break-points ; |
(iv) |
at least one of the functions must be nonzero so that there is a time derivative present in the problem; |
(v) |
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 by either specifying the solution at or by specifying a zero flux there, that is and . See also Section 9. |
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 D03PDF/D03PDA 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. In the case of just one element, the break-points are the boundaries. 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 and () ODEs for each PDE component between each pair of break-points. The system is then integrated forwards in time using a backward differentiation formula 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
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: – INTEGERInput
-
On entry: the number of PDEs in the system to be solved.
Constraint:
.
- 2: – INTEGERInput
-
On entry: the coordinate system used:
- Indicates Cartesian coordinates.
- Indicates cylindrical polar coordinates.
- Indicates spherical polar coordinates.
Constraint:
, or .
- 3: – 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: – REAL (KIND=nag_wp)Input
-
On entry: the final value of to which the integration is to be carried out.
- 5: – SUBROUTINE, supplied by the user.External Procedure
-
PDEDEF must compute the values of the functions
,
and
which define the system of PDEs. The functions may depend on
,
,
and
and must be evaluated at a set of points.
The specification of
PDEDEF
for D03PDF is:
INTEGER |
NPDE, NPTL, IRES |
REAL (KIND=nag_wp) |
T, X(NPTL), U(NPDE,NPTL), UX(NPDE,NPTL), P(NPDE,NPDE,NPTL), Q(NPDE,NPTL), R(NPDE,NPTL) |
|
The specification of
PDEDEF
for D03PDA is:
SUBROUTINE PDEDEF ( |
NPDE, T, X, NPTL, U, UX, P, Q, R, IRES, IUSER, RUSER) |
INTEGER |
NPDE, NPTL, IRES, IUSER(*) |
REAL (KIND=nag_wp) |
T, X(NPTL), U(NPDE,NPTL), UX(NPDE,NPTL), P(NPDE,NPDE,NPTL), Q(NPDE,NPTL), R(NPDE,NPTL), RUSER(*) |
|
- 1: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 2: – REAL (KIND=nag_wp)Input
-
On entry: the current value of the independent variable .
- 3: – 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: – INTEGERInput
-
On entry: the number of points at which evaluations are required (the value of ).
- 5: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of the component where , for and .
- 6: – REAL (KIND=nag_wp) arrayInput
-
On entry: contains the value of the component where , for and .
- 7: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must be set to the value of where , for , and .
- 8: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must be set to the value of where , for and .
- 9: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must be set to the value of where , for and .
- 10: – 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 D03PDF/D03PDA returns to the calling subroutine with the error indicator set to .
- Note: the following are additional parameters for specific use with D03PDA. Users of D03PDF therefore need not read the remainder of this description.
- 11: – INTEGER arrayUser Workspace
- 12: – REAL (KIND=nag_wp) arrayUser Workspace
-
PDEDEF is called with the parameters
IUSER and
RUSER as supplied to D03PDF/D03PDA. 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 D03PDF/D03PDA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 6: – SUBROUTINE, supplied by the user.External Procedure
-
BNDARY must compute the functions
and
which define the boundary conditions as in equation
(3).
The specification of
BNDARY
for D03PDF is:
INTEGER |
NPDE, IBND, IRES |
REAL (KIND=nag_wp) |
T, U(NPDE), UX(NPDE), BETA(NPDE), GAMMA(NPDE) |
|
The specification of
BNDARY
for D03PDA is:
INTEGER |
NPDE, IBND, IRES, IUSER(*) |
REAL (KIND=nag_wp) |
T, U(NPDE), UX(NPDE), BETA(NPDE), GAMMA(NPDE), RUSER(*) |
|
- 1: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 2: – REAL (KIND=nag_wp)Input
-
On entry: the current value of the independent variable .
- 3: – REAL (KIND=nag_wp) arrayInput
-
On entry:
contains the value of the component
at the boundary specified by
IBND, for
.
- 4: – REAL (KIND=nag_wp) arrayInput
-
On entry:
contains the value of the component
at the boundary specified by
IBND, for
.
- 5: – 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, .
- 6: – REAL (KIND=nag_wp) arrayOutput
-
On exit:
must be set to the value of
at the boundary specified by
IBND, for
.
- 7: – REAL (KIND=nag_wp) arrayOutput
-
On exit:
must be set to the value of
at the boundary specified by
IBND, for
.
- 8: – 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 D03PDF/D03PDA returns to the calling subroutine with the error indicator set to .
- Note: the following are additional parameters for specific use with D03PDA. Users of D03PDF therefore need not read the remainder of this description.
- 9: – INTEGER arrayUser Workspace
- 10: – REAL (KIND=nag_wp) arrayUser Workspace
-
BNDARY is called with the parameters
IUSER and
RUSER as supplied to D03PDF/D03PDA. 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 D03PDF/D03PDA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 7: – REAL (KIND=nag_wp) arrayInput/Output
-
On entry: if
the value of
U must be unchanged from the previous call.
On exit: will contain the computed solution at .
- 8: – INTEGERInput
-
On entry: the number of break-points in the interval .
Constraint:
.
- 9: – 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: – 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: – INTEGERInput
-
On entry: the number of mesh points in the interval .
Constraint:
.
- 12: – REAL (KIND=nag_wp) arrayOutput
-
On exit: the mesh points chosen by D03PDF/D03PDA in the spatial direction. The values of
X will satisfy
.
- 13: – SUBROUTINE, supplied by the user.External Procedure
-
UINIT must compute the initial values of the PDE components
, for
and
.
The specification of
UINIT
for D03PDF is:
INTEGER |
NPDE, NPTS |
REAL (KIND=nag_wp) |
X(NPTS), U(NPDE,NPTS) |
|
The specification of
UINIT
for D03PDA is:
INTEGER |
NPDE, NPTS, IUSER(*) |
REAL (KIND=nag_wp) |
X(NPTS), U(NPDE,NPTS), RUSER(*) |
|
- 1: – INTEGERInput
-
On entry: the number of PDEs in the system.
- 2: – INTEGERInput
-
On entry: the number of mesh points in the interval .
- 3: – REAL (KIND=nag_wp) arrayInput
-
On entry: , contains the values of the th mesh point, for .
- 4: – REAL (KIND=nag_wp) arrayOutput
-
On exit: must be set to the initial value , for and .
- Note: the following are additional parameters for specific use with D03PDA. Users of D03PDF therefore need not read the remainder of this description.
- 5: – INTEGER arrayUser Workspace
- 6: – REAL (KIND=nag_wp) arrayUser Workspace
-
UINIT is called with the parameters
IUSER and
RUSER as supplied to D03PDF/D03PDA. You are free to use the arrays
IUSER and
RUSER to supply information to
UINIT as an alternative to using COMMON global variables.
UINIT must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PDF/D03PDA is called. Parameters denoted as
Input must
not be changed by this procedure.
- 14: – REAL (KIND=nag_wp)Input
-
On entry: a positive quantity for controlling the local error estimate in the time integration. If
is the estimated error for
at the
th mesh point, the error test is:
Constraint:
.
- 15: – 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.
- 16: – INTEGERInput
-
On entry: the dimension of the array
RSAVE as declared in the (sub)program from which D03PDF/D03PDA is called.
Constraint:
.
- 17: – 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. 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 last backward differentiation formula method used.
- Contains the number of Newton iterations performed by the time integrator. Each iteration involves an ODE residual evaluation followed by a back-substitution using the decomposition of the Jacobian matrix.
- 18: – INTEGERInput
-
On entry: the dimension of the array
ISAVE as declared in the (sub)program from which D03PDF/D03PDA is called.
Constraint:
.
- 19: – 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 .
Constraint:
, or .
- 20: – INTEGERInput
-
On entry: the level of trace information required from D03PDF/D03PDA 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.
- 21: – 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 D03PDF/D03PDA.
Constraint:
or .
On exit: .
- 22: – INTEGERInput/Output
-
Note: for D03PDA, 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 D03PDA. Users of D03PDF therefore need not read the remainder of this description.
- 22: – INTEGER arrayUser Workspace
-
IUSER is not used by D03PDF/D03PDA, but is passed directly to
PDEDEF,
BNDARY and
UINIT and may be used to pass information to these routines as an alternative to using COMMON global variables.
- 23: – REAL (KIND=nag_wp) arrayUser Workspace
- 24: – CHARACTER(80) arrayCommunication Array
-
- 25: – LOGICAL arrayCommunication Array
-
- 26: – INTEGER arrayCommunication Array
-
- 27: – REAL (KIND=nag_wp) arrayCommunication Array
-
- 28: – 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, | , |
or | is too small, |
or | , or , |
or | , or , |
or | and , |
or | , |
or | , |
or | or , |
or | , |
or | , |
or | or , |
or | break-points are not ordered, |
or | LRSAVE is too small, |
or | LISAVE is too small. |
-
The underlying ODE solver cannot make any further progress across the integration range from the current point
with the supplied value of
ACC. The components of
U contain the computed values at the current point
.
-
In the underlying ODE solver, there were repeated errors or corrector convergence test failures on an attempted step, before completing the requested task. The problem may have a singularity or
ACC is too small for the integration to continue. Integration was successful as far as
.
-
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 or
BNDARY, 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 or
BNDARY. Integration was successful as far as
.
-
The value of
ACC is so small that the routine is unable to start the integration in time.
-
In one of
PDEDEF or
BNDARY,
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
ACC is unlikely to produce any change in the computed solution. (Only applies when you are not operating in one step mode, that is when
.)
-
An error occurred during Jacobian formulation of the ODE system (a more detailed error description may be directed to the current error message unit).
-
Not applicable.
-
Not applicable.
-
The flux function was detected as depending on time derivatives, which is not permissible.
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.8 in the Essential Introduction for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 3.7 in the Essential Introduction for further information.
Dynamic memory allocation failed.
See
Section 3.6 in the Essential Introduction for further information.
7 Accuracy
D03PDF/D03PDA controls the accuracy of the integration in the time direction but not the accuracy of the approximation in space. The spatial accuracy depends on the degree of the polynomial approximation
NPOLY, and on both the number of break-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,
ACC.
8 Parallelism and Performance
D03PDF/D03PDA is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
D03PDF/D03PDA 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.
D03PDF/D03PDA is designed to solve parabolic systems (possibly including elliptic equations) with second-order derivatives in space. 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.
10 Example
The problem consists of a fourth-order PDE which can be written as a pair of second-order elliptic-parabolic PDEs for
and
,
where
and
. The boundary conditions are given by
The initial conditions at
are given by
The absence of boundary conditions for
does not pose any difficulties provided that the derivative flux boundary conditions are assigned to the first PDE
(4) which has the correct flux,
. The conditions on
at the boundaries are assigned to the second PDE by setting
in equation
(3) and placing the Dirichlet boundary conditions on
in the function
.
10.1 Program Text
Note: the following programs illustrate the use of D03PDF and D03PDA.
Program Text (d03pdfe.f90)
Program Text (d03pdae.f90)
10.2 Program Data
Program Data (d03pdfe.d)
Program Data (d03pdae.d)
10.3 Program Results
Program Results (d03pdfe.r)
Program Results (d03pdae.r)