NAG CL Interface
d03pcc (dim1_​parab_​fd)

Settings help

CL Name Style:


1 Purpose

d03pcc integrates a system of linear or nonlinear parabolic partial differential equations (PDEs) in one space variable. The spatial discretization is performed using finite differences, 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.

2 Specification

#include <nag.h>
void  d03pcc (Integer npde, Integer m, double *ts, double tout,
void (*pdedef)(Integer npde, double t, double x, const double u[], const double ux[], double p[], double q[], double r[], Integer *ires, Nag_Comm *comm),
void (*bndary)(Integer npde, double t, const double u[], const double ux[], Integer ibnd, double beta[], double gamma[], Integer *ires, Nag_Comm *comm),
double u[], Integer npts, const double x[], double acc, double rsave[], Integer lrsave, Integer isave[], Integer lisave, Integer itask, Integer itrace, const char *outfile, Integer *ind, Nag_Comm *comm, Nag_D03_Save *saved, NagError *fail)
The function may be called by the names: d03pcc, nag_pde_dim1_parab_fd or nag_pde_parab_1d_fd.

3 Description

d03pcc integrates the system of parabolic equations:
j=1npdePi,j Uj t +Qi=x-m x (xmRi),  i=1,2,,npde,  axb,  tt0, (1)
where Pi,j, Qi and Ri depend on x, t, U, Ux and the vector U is the set of solution values
U (x,t) = [ U 1 (x,t) ,, U npde (x,t) ] T , (2)
and the vector Ux is its partial derivative with respect to x. Note that Pi,j, Qi and Ri must not depend on U t .
The integration in time is from t0 to tout, over the space interval axb, where a=x1 and b=xnpts are the leftmost and rightmost points of a user-defined mesh x1,x2,,xnpts. The coordinate system in space is defined by the value of m; m=0 for Cartesian coordinates, m=1 for cylindrical polar coordinates and m=2 for spherical polar coordinates. The mesh should be chosen in accordance with the expected behaviour of the solution.
The system is defined by the functions Pi,j, Qi and Ri which must be specified in pdedef.
The initial values of the functions U(x,t) must be given at t=t0. The functions Ri, for i=1,2,,npde, 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
βi(x,t)Ri(x,t,U,Ux)=γi(x,t,U,Ux),  i=1,2,,npde, (3)
where x=a or x=b.
The boundary conditions must be specified in bndary.
The problem is subject to the following restrictions:
  1. (i)t0<tout, so that integration is in the forward direction;
  2. (ii)Pi,j, Qi and the flux Ri must not depend on any time derivatives;
  3. (iii)the evaluation of the functions Pi,j, Qi and Ri is done at the mid-points of the mesh intervals by calling the pdedef for each mid-point in turn. Any discontinuities in these functions must, therefore, be at one or more of the mesh points x1,x2,,xnpts;
  4. (iv)at least one of the functions Pi,j must be nonzero so that there is a time derivative present in the problem; and
  5. (v)if m>0 and x1=0.0, 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 x=0.0 or by specifying a zero flux there, that is βi=1.0 and γi=0.0. See also Section 9.
The parabolic equations are approximated by a system of ODEs in time for the values of Ui at mesh points. For simple problems in Cartesian coordinates, this system is obtained by replacing the space derivatives by the usual central, three-point finite difference formula. However, for polar and spherical problems, or problems with nonlinear coefficients, the space derivatives are replaced by a modified three-point formula which maintains second-order accuracy. In total there are npde×npts ODEs in the time direction. This 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, Dew P M and Furzeland R M (1989) Developing software for time-dependent problems using the method of lines and differential-algebraic integrators Appl. Numer. Math. 5 375–397
Dew P M and Walsh J (1981) A set of library routines for solving parabolic equations in one space variable ACM Trans. Math. Software 7 295–314
Pennington S V and Berzins M (1994) New NAG Library software for first-order partial differential equations ACM Trans. Math. Softw. 20 63–99
Skeel R D and Berzins M (1990) A method for the spatial discretization of parabolic equations in one space variable SIAM J. Sci. Statist. Comput. 11(1) 1–32

5 Arguments

1: npde Integer Input
On entry: the number of PDEs in the system to be solved.
Constraint: npde1.
2: m Integer Input
On entry: the coordinate system used:
m=0
Indicates Cartesian coordinates.
m=1
Indicates cylindrical polar coordinates.
m=2
Indicates spherical polar coordinates.
Constraint: m=0, 1 or 2.
3: ts double * Input/Output
On entry: the initial value of the independent variable t.
On exit: the value of t corresponding to the solution values in u. Normally ts=tout.
Constraint: ts<tout.
4: tout double Input
On entry: the final value of t to which the integration is to be carried out.
5: pdedef function, supplied by the user External Function
pdedef must compute the functions Pi,j, Qi and Ri which define the system of PDEs. pdedef is called approximately midway between each pair of mesh points in turn by d03pcc.
The specification of pdedef is:
void  pdedef (Integer npde, double t, double x, const double u[], const double ux[], double p[], double q[], double r[], Integer *ires, Nag_Comm *comm)
1: npde Integer Input
On entry: the number of PDEs in the system.
2: t double Input
On entry: the current value of the independent variable t.
3: x double Input
On entry: the current value of the space variable x.
4: u[npde] const double Input
On entry: u[i-1] contains the value of the component Ui(x,t), for i=1,2,,npde.
5: ux[npde] const double Input
On entry: ux[i-1] contains the value of the component Ui(x,t) x , for i=1,2,,npde.
6: p[npde×npde] double Output
Note: the (i,j)th element of the matrix P is stored in p[(j-1)×npde+i-1].
On exit: p[(j-1)×npde+i-1] must be set to the value of Pi,j(x,t,U,Ux), for i=1,2,,npde and j=1,2,,npde.
7: q[npde] double Output
On exit: q[i-1] must be set to the value of Qi(x,t,U,Ux), for i=1,2,,npde.
8: r[npde] double Output
On exit: r[i-1] must be set to the value of Ri(x,t,U,Ux), for i=1,2,,npde.
9: ires Integer * Input/Output
On entry: set to −1 or 1.
On exit: should usually remain unchanged. However, you may set ires to force the integration function to take certain actions as described below:
ires=2
Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to fail.code= NE_USER_STOP.
ires=3
Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set ires=3 when a physically meaningless input or output value has been generated. If you consecutively set ires=3, d03pcc returns to the calling function with the error indicator set to fail.code= NE_FAILED_DERIV.
10: comm Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to pdedef.
userdouble *
iuserInteger *
pPointer 
The type Pointer will be void *. Before calling d03pcc you may allocate memory and initialize these pointers with various quantities for use by pdedef when called from d03pcc (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
Note: pdedef should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pcc. If your code inadvertently does return any NaNs or infinities, d03pcc is likely to produce unexpected results.
6: bndary function, supplied by the user External Function
bndary must compute the functions βi and γi which define the boundary conditions as in equation (3).
The specification of bndary is:
void  bndary (Integer npde, double t, const double u[], const double ux[], Integer ibnd, double beta[], double gamma[], Integer *ires, Nag_Comm *comm)
1: npde Integer Input
On entry: the number of PDEs in the system.
2: t double Input
On entry: the current value of the independent variable t.
3: u[npde] const double Input
On entry: u[i-1] contains the value of the component Ui(x,t) at the boundary specified by ibnd, for i=1,2,,npde.
4: ux[npde] const double Input
On entry: ux[i-1] contains the value of the component Ui(x,t) x at the boundary specified by ibnd, for i=1,2,,npde.
5: ibnd Integer Input
On entry: determines the position of the boundary conditions.
ibnd=0
bndary must set up the coefficients of the left-hand boundary, x=a.
ibnd0
Indicates that bndary must set up the coefficients of the right-hand boundary, x=b.
6: beta[npde] double Output
On exit: beta[i-1] must be set to the value of βi(x,t) at the boundary specified by ibnd, for i=1,2,,npde.
7: gamma[npde] double Output
On exit: gamma[i-1] must be set to the value of γi(x,t,U,Ux) at the boundary specified by ibnd, for i=1,2,,npde.
8: ires Integer * Input/Output
On entry: set to −1 or 1.
On exit: should usually remain unchanged. However, you may set ires to force the integration function to take certain actions as described below:
ires=2
Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to fail.code= NE_USER_STOP.
ires=3
Indicates to the integrator that the current time step should be abandoned and a smaller time step used instead. You may wish to set ires=3 when a physically meaningless input or output value has been generated. If you consecutively set ires=3, d03pcc returns to the calling function with the error indicator set to fail.code= NE_FAILED_DERIV.
9: comm Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to bndary.
userdouble *
iuserInteger *
pPointer 
The type Pointer will be void *. Before calling d03pcc you may allocate memory and initialize these pointers with various quantities for use by bndary when called from d03pcc (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
Note: bndary should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pcc. If your code inadvertently does return any NaNs or infinities, d03pcc is likely to produce unexpected results.
7: u[npde×npts] double Input/Output
Note: the (i,j)th element of the matrix U is stored in u[(j-1)×npde+i-1].
On entry: the initial values of U(x,t) at t=ts and the mesh points x[j-1], for j=1,2,,npts.
On exit: u[(j-1)×npde+i-1] will contain the computed solution at t=ts.
8: npts Integer Input
On entry: the number of mesh points in the interval [a,b].
Constraint: npts3.
9: x[npts] const double Input
On entry: the mesh points in the spatial direction. x[0] must specify the left-hand boundary, a, and x[npts-1] must specify the right-hand boundary, b.
Constraint: x[0]<x[1]<<x[npts-1].
10: acc double Input
On entry: a positive quantity for controlling the local error estimate in the time integration. If E(i,j) is the estimated error for Ui at the jth mesh point, the error test is:
|E(i,j)|=acc×(1.0+|u[(j-1)×npde+i-1]|).  
Constraint: acc>0.0.
11: rsave[lrsave] double Communication Array
If ind=0, rsave need not be set on entry.
If ind=1, rsave must be unchanged from the previous call to the function because it contains required information about the iteration.
12: lrsave Integer Input
On entry: the dimension of the array rsave.
Constraint: lrsave(6×npde+10)×npde×npts+(3×npde+21)×npde+7×npts+54.
13: isave[lisave] Integer Communication Array
If ind=0, isave need not be set on entry.
If ind=1, isave must be unchanged from the previous call to the function because it contains required information about the iteration. In particular:
isave[0]
Contains the number of steps taken in time.
isave[1]
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.
isave[2]
Contains the number of Jacobian evaluations performed by the time integrator.
isave[3]
Contains the order of the last backward differentiation formula method used.
isave[4]
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 LU decomposition of the Jacobian matrix.
14: lisave Integer Input
On entry: the dimension of the array isave.
Constraint: lisavenpde×npts+24.
15: itask Integer Input
On entry: specifies the task to be performed by the ODE integrator.
itask=1
Normal computation of output values u at t=tout.
itask=2
One step and return.
itask=3
Stop at first internal integration point at or beyond t=tout.
Constraint: itask=1, 2 or 3.
16: itrace Integer Input
On entry: the level of trace information required from d03pcc and the underlying ODE solver. itrace may take the value −1, 0, 1, 2 or 3.
itrace=−1
No output is generated.
itrace=0
Only warning messages from the PDE solver are printed.
itrace>0
Output from the underlying ODE solver is printed. This output contains details of Jacobian entries, the nonlinear iteration and the time integration during the computation of the ODE system.
If itrace<−1, −1 is assumed and similarly if itrace>3, 3 is assumed.
The advisory messages are given in greater detail as itrace increases.
17: outfile const char * Input
On entry: the name of a file to which diagnostic output will be directed. If outfile is NULL the diagnostic output will be directed to standard output.
18: ind Integer * Input/Output
On entry: indicates whether this is a continuation call or a new integration.
ind=0
Starts or restarts the integration in time.
ind=1
Continues the integration after an earlier exit from the function. In this case, only the argument tout should be reset between calls to d03pcc.
Constraint: ind=0 or 1.
On exit: ind=1.
19: comm Nag_Comm *
The NAG communication argument (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
20: saved Nag_D03_Save * Communication Structure
saved must remain unchanged following a previous call to a Chapter D03 function and prior to any subsequent call to a Chapter D03 function.
21: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_ACC_IN_DOUBT
Integration completed, but a small change in acc is unlikely to result in a changed solution. acc=value.
NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_FAILED_DERIV
In setting up the ODE system an internal auxiliary was unable to initialize the derivative. This could be due to your setting ires=3 in pdedef or bndary.
NE_FAILED_START
acc was too small to start integration: acc=value.
NE_FAILED_STEP
Error during Jacobian formulation for ODE system. Increase itrace for further details.
Repeated errors in an attempted step of underlying ODE solver. Integration was successful as far as ts: ts=value.
Underlying ODE solver cannot make further progress from the point ts with the supplied value of acc. ts=value, acc=value.
NE_INCOMPAT_PARAM
On entry, m=value and x[0]=value.
Constraint: m0 or x[0]0.0
NE_INT
ires set to an invalid value in call to pdedef or bndary.
On entry, ind=value.
Constraint: ind=0 or 1.
On entry, itask=value.
Constraint: itask=1, 2 or 3.
On entry, m=value.
Constraint: m=0, 1 or 2.
On entry, npde=value.
Constraint: npde1.
On entry, npts=value.
Constraint: npts3.
On entry, on initial entry ind=1.
Constraint: on initial entry ind=0.
NE_INT_2
On entry, lisave=value.
Constraint: lisavevalue.
On entry, lrsave=value.
Constraint: lrsavevalue.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
Serious error in internal call to an auxiliary. Increase itrace for further details.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_NOT_CLOSE_FILE
Cannot close file value.
NE_NOT_STRICTLY_INCREASING
On entry, i=value, x[i-1]=value, j=value and x[j-1]=value.
Constraint: x[0]<x[1]<<x[npts-1].
NE_NOT_WRITE_FILE
Cannot open file value for writing.
NE_REAL
On entry, acc=value.
Constraint: acc>0.0.
NE_REAL_2
On entry, tout=value and ts=value.
Constraint: tout>ts.
On entry, tout-ts is too small: tout=value and ts=value.
NE_SING_JAC
Singular Jacobian of ODE system. Check problem formulation.
NE_TIME_DERIV_DEP
Flux function appears to depend on time derivatives.
NE_USER_STOP
In evaluating residual of ODE system, ires=2 has been set in pdedef or bndary. Integration is successful as far as ts: ts=value.

7 Accuracy

d03pcc 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 argument, acc.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
d03pcc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
d03pcc 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 function. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9 Further Comments

d03pcc is designed to solve parabolic systems (possibly including some elliptic equations) with second-order derivatives in space. The argument 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. It may be advisable in such cases to reduce the whole system to first-order and to use the Keller box scheme function d03pec.
The time taken depends on the complexity of the parabolic system and on the accuracy requested.

10 Example

We use the example given in Dew and Walsh (1981) which consists of an elliptic-parabolic pair of PDEs. The problem was originally derived from a single third-order in space PDE. The elliptic equation is
1r r (r2 U1 r )=4α (U2+r U2 r )  
and the parabolic equation is
(1-r2) U2 t =1r r (r( U2 r -U2U1))  
where (r,t)[0,1]×[0,1]. The boundary conditions are given by
U1= U2 r =0  at ​r=0,  
and
r (rU1)= 0   and   U2= 0   at ​ r=1.  
The first of these boundary conditions implies that the flux term in the second PDE, ( U2 r -U2U1) , is zero at r=0.
The initial conditions at t=0 are given by
U1=2αr  and  U2=1.0,   ​r[0,1].  
The value α=1 was used in the problem definition. A mesh of 20 points was used with a circular mesh spacing to cluster the points towards the right-hand side of the spatial interval, r=1.

10.1 Program Text

Program Text (d03pcce.c)

10.2 Program Data

None.

10.3 Program Results

Program Results (d03pcce.r)
GnuplotProduced by GNUPLOT 5.0 patchlevel 0 Example Program Solution, U(1,x,t), of Elliptic-parabolic Pair using Method of Lines and BDF Method U(1,x,t) gnuplot_plot_1 gnuplot_plot_2 0.000010 0.000100 0.001000 0.010000 0.100000 1.000000 Time (logscale) 0 0.2 0.4 0.6 0.8 1 x 0 0.2 0.4 0.6 0.8 1 1.2 1.4 1.6 1.8 2
GnuplotProduced by GNUPLOT 5.0 patchlevel 0 Solution, U(2,x,t), of Elliptic-parabolic Pair using Finite-differences and BDF U(2,x,t) gnuplot_plot_1 gnuplot_plot_2 0.000010 0.000100 0.001000 0.010000 0.100000 1.000000 Time (logscale) 0 0.2 0.4 0.6 0.8 1 x 0 0.1 0.2 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1