NAG Library Routine Document
D03PFF
1 Purpose
D03PFF integrates a system of linear or nonlinear convectiondiffusion equations in one space dimension, with optional source terms. The system must be posed in conservative form. Convection terms are discretized using a sophisticated upwind scheme involving a usersupplied numerical flux function based on the solution of a Riemann problem at each mesh point. The method of lines is employed to reduce the PDEs to a system of ordinary differential equations (ODEs), and the resulting system is solved using a backward differentiation formula (BDF) method.
2 Specification
SUBROUTINE D03PFF ( 
NPDE, TS, TOUT, PDEDEF, NUMFLX, BNDARY, U, NPTS, X, ACC, TSMAX, RSAVE, LRSAVE, ISAVE, LISAVE, ITASK, ITRACE, IND, IFAIL) 
INTEGER 
NPDE, NPTS, LRSAVE, ISAVE(LISAVE), LISAVE, ITASK, ITRACE, IND, IFAIL 
REAL (KIND=nag_wp) 
TS, TOUT, U(NPDE,NPTS), X(NPTS), ACC(2), TSMAX, RSAVE(LRSAVE) 
EXTERNAL 
PDEDEF, NUMFLX, BNDARY 

3 Description
D03PFF integrates the system of convectiondiffusion equations in conservative form:
or the hyperbolic convectiononly system:
for
$i=1,2,\dots ,{\mathbf{NPDE}}\text{, \hspace{1em}}a\le x\le b\text{, \hspace{1em}}t\ge {t}_{0}$, where the vector
$U$ is the set of solution values
The functions
${P}_{i,j}$,
${F}_{i}$,
${C}_{i}$ and
${S}_{i}$ depend on
$x$,
$t$ and
$U$; and
${D}_{i}$ depends on
$x$,
$t$,
$U$ and
${U}_{x}$, where
${U}_{x}$ is the spatial derivative of
$U$. Note that
${P}_{i,j}$,
${F}_{i}$,
${C}_{i}$ and
${S}_{i}$ must not depend on any space derivatives; and none of the functions may depend on time derivatives. In terms of conservation laws,
${F}_{i}$,
$\frac{{C}_{i}\partial {D}_{i}}{\partial x}$ and
${S}_{i}$ are the convective flux, diffusion and source terms respectively.
The integration in time is from ${t}_{0}$ to ${t}_{\mathrm{out}}$, over the space interval $a\le x\le b$, where $a={x}_{1}$ and $b={x}_{{\mathbf{NPTS}}}$ are the leftmost and rightmost points of a userdefined mesh ${x}_{1},{x}_{2},\dots ,{x}_{{\mathbf{NPTS}}}$. The initial values of the functions $U\left(x,t\right)$ must be given at $t={t}_{0}$.
The PDEs are approximated by a system of ODEs in time for the values of
${U}_{i}$ at mesh points using a spatial discretization method similar to the centraldifference scheme used in
D03PCF/D03PCA,
D03PHF/D03PHA and
D03PPF/D03PPA, but with the flux
${F}_{i}$ replaced by a
numerical flux, which is a representation of the flux taking into account the direction of the flow of information at that point (i.e., the direction of the characteristics). Simple central differencing of the numerical flux then becomes a sophisticated upwind scheme in which the correct direction of upwinding is automatically achieved.
The numerical flux vector,
${\hat{F}}_{i}$ say, must be calculated by you in terms of the
left and
right values of the solution vector
$U$ (denoted by
${U}_{L}$ and
${U}_{R}$ respectively), at each midpoint of the mesh
${x}_{j1/2}=\left({x}_{j1}+{x}_{j}\right)/2$, for
$j=2,3,\dots ,{\mathbf{NPTS}}$. The left and right values are calculated by D03PFF from two adjacent mesh points using a standard upwind technique combined with a Van Leer slopelimiter (see
LeVeque (1990)). The physically correct value for
${\hat{F}}_{i}$ is derived from the solution of the Riemann problem given by
where
$y=x{x}_{j1/2}$, i.e.,
$y=0$ corresponds to
$x={x}_{j1/2}$, with discontinuous initial values
$U={U}_{L}$ for
$y<0$ and
$U={U}_{R}$ for
$y>0$, using an
approximate Riemann solver. This applies for either of the systems
(1) or
(2); the numerical flux is independent of the functions
${P}_{i,j}$,
${C}_{i}$,
${D}_{i}$ and
${S}_{i}$. A description of several approximate Riemann solvers can be found in
LeVeque (1990) and
Berzins et al. (1989). Roe's scheme (see
Roe (1981)) is perhaps the easiest to understand and use, and a brief summary follows. Consider the system of PDEs
${U}_{t}+{F}_{x}=0$ or equivalently
${U}_{t}+A{U}_{x}=0$. Provided the system is linear in
$U$, i.e., the Jacobian matrix
$A$ does not depend on
$U$, the numerical flux
$\hat{F}$ is given by
where
${F}_{L}$ (
${F}_{R}$) is the flux
$F$ calculated at the left (right) value of
$U$, denoted by
${U}_{L}$ (
${U}_{R}$); the
${\lambda}_{k}$ are the eigenvalues of
$A$; the
${e}_{k}$ are the right eigenvectors of
$A$; and the
${\alpha}_{k}$ are defined by
An example is given in
Section 10.
If the system is nonlinear, Roe's scheme requires that a linearized Jacobian is found (see
Roe (1981)).
The functions
${P}_{i,j}$,
${C}_{i}$,
${D}_{i}$ and
${S}_{i}$ (but
not
${F}_{i}$) must be specified in a
PDEDEF. The numerical flux
${\hat{F}}_{i}$ must be supplied in a separate
NUMFLX. For problems in the form
(2), the actual argument D03PFP may be used for
PDEDEF. D03PFP is included in the NAG Library and sets the matrix with entries
${P}_{i,j}$ to the identity matrix, and the functions
${C}_{i}$,
${D}_{i}$ and
${S}_{i}$ to zero.
The boundary condition specification has sufficient flexibility to allow for different types of problems. For secondorder problems, i.e.,
${D}_{i}$ depending on
${U}_{x}$, a boundary condition is required for each PDE at both boundaries for the problem to be wellposed. If there are no secondorder terms present, then the continuous PDE problem generally requires exactly one boundary condition for each PDE, that is
NPDE boundary conditions in total. However, in common with most discretization schemes for firstorder problems, a
numerical boundary condition is required at the other boundary for each PDE. In order to be consistent with the characteristic directions of the PDE system, the numerical boundary conditions must be derived from the solution inside the domain in some manner (see below). You must supply both types of boundary conditions, i.e., a total of
NPDE conditions at each boundary point.
The position of each boundary condition should be chosen with care. In simple terms, if information is flowing into the domain then a physical boundary condition is required at that boundary, and a numerical boundary condition is required at the other boundary. In many cases the boundary conditions are simple, e.g., for the linear advection equation. In general you should calculate the characteristics of the PDE system and specify a physical boundary condition for each of the characteristic variables associated with incoming characteristics, and a numerical boundary condition for each outgoing characteristic.
A common way of providing numerical boundary conditions is to extrapolate the characteristic variables from the inside of the domain. Note that only linear extrapolation is allowed in this routine (for greater flexibility the routine
D03PLF should be used). For problems in which the solution is known to be uniform (in space) towards a boundary during the period of integration then extrapolation is unnecessary; the numerical boundary condition can be supplied as the known solution at the boundary. Examples can be found in
Section 10.
The boundary conditions must be specified in
BNDARY in the form
at the lefthand boundary, and
at the righthand boundary.
Note that spatial derivatives at the boundary are not passed explicitly to
BNDARY, but they can be calculated using values of
$U$ at and adjacent to the boundaries if required. However, it should be noted that instabilities may occur if such onesided differencing opposes the characteristic direction at the boundary.
The problem is subject to the following restrictions:
(i) 
${P}_{i,j}$, ${F}_{i}$, ${C}_{i}$ and ${S}_{i}$ must not depend on any space derivatives; 
(ii) 
${P}_{i,j}$, ${F}_{i}$, ${C}_{i}$, ${D}_{i}$ and ${S}_{i}$ must not depend on any time derivatives; 
(iii) 
${t}_{0}<{t}_{\mathrm{out}}$, so that integration is in the forward direction; 
(iv) 
The evaluation of the terms ${P}_{i,j}$, ${C}_{i}$, ${D}_{i}$ and ${S}_{i}$ is done by calling the PDEDEF at a point approximately midway between each pair of mesh points in turn. Any discontinuities in these functions must therefore be at one or more of the mesh points ${x}_{1},{x}_{2},\dots ,{x}_{{\mathbf{NPTS}}}$; 
(v) 
At least one of the functions ${P}_{i,j}$ must be nonzero so that there is a time derivative present in the PDE problem. 
In total there are ${\mathbf{NPDE}}\times {\mathbf{NPTS}}$ ODEs in the time direction. This system is then integrated forwards in time using a BDF method.
For further details of the algorithm, see
Pennington and Berzins (1994) and the references therein.
4 References
Berzins M, Dew P M and Furzeland R M (1989) Developing software for timedependent problems using the method of lines and differentialalgebraic integrators Appl. Numer. Math. 5 375–397
Hirsch C (1990) Numerical Computation of Internal and External Flows, Volume 2: Computational Methods for Inviscid and Viscous Flows John Wiley
LeVeque R J (1990) Numerical Methods for Conservation Laws Birkhäuser Verlag
Pennington S V and Berzins M (1994) New NAG Library software for firstorder partial differential equations ACM Trans. Math. Softw. 20 63–99
Roe P L (1981) Approximate Riemann solvers, parameter vectors, and difference schemes J. Comput. Phys. 43 357–372
5 Parameters
 1: $\mathrm{NPDE}$ – INTEGERInput

On entry: the number of PDEs to be solved.
Constraint:
${\mathbf{NPDE}}\ge 1$.
 2: $\mathrm{TS}$ – REAL (KIND=nag_wp)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
${\mathbf{TS}}={\mathbf{TOUT}}$.
Constraint:
${\mathbf{TS}}<{\mathbf{TOUT}}$.
 3: $\mathrm{TOUT}$ – REAL (KIND=nag_wp)Input

On entry: the final value of $t$ to which the integration is to be carried out.
 4: $\mathrm{PDEDEF}$ – SUBROUTINE, supplied by the NAG Library or the user.External Procedure

PDEDEF must evaluate the functions
${P}_{i,j}$,
${C}_{i}$,
${D}_{i}$ and
${S}_{i}$ which partially define the system of PDEs.
${P}_{i,j}$,
${C}_{i}$ and
${S}_{i}$ may depend on
$x$,
$t$ and
$U$;
${D}_{i}$ may depend on
$x$,
$t$,
$U$ and
${U}_{x}$.
PDEDEF is called approximately midway between each pair of mesh points in turn by D03PFF. The actual argument D03PFP may be used for
PDEDEF for problems in the form
(2). (D03PFP is included in the NAG Library.)
The specification of
PDEDEF is:
INTEGER 
NPDE, IRES 
REAL (KIND=nag_wp) 
T, X, U(NPDE), UX(NPDE), P(NPDE,NPDE), C(NPDE), D(NPDE), S(NPDE) 

 1: $\mathrm{NPDE}$ – INTEGERInput

On entry: the number of PDEs in the system.
 2: $\mathrm{T}$ – REAL (KIND=nag_wp)Input

On entry: the current value of the independent variable $t$.
 3: $\mathrm{X}$ – REAL (KIND=nag_wp)Input

On entry: the current value of the space variable $x$.
 4: $\mathrm{U}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: ${\mathbf{U}}\left(\mathit{i}\right)$ contains the value of the component ${U}_{\mathit{i}}\left(x,t\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 5: $\mathrm{UX}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: ${\mathbf{UX}}\left(\mathit{i}\right)$ contains the value of the component $\frac{\partial {U}_{\mathit{i}}\left(x,t\right)}{\partial x}$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 6: $\mathrm{P}\left({\mathbf{NPDE}},{\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: ${\mathbf{P}}\left(\mathit{i},\mathit{j}\right)$ must be set to the value of ${P}_{\mathit{i},\mathit{j}}\left(x,t,U\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{NPDE}}$.
 7: $\mathrm{C}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: ${\mathbf{C}}\left(\mathit{i}\right)$ must be set to the value of ${C}_{\mathit{i}}\left(x,t,U\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 8: $\mathrm{D}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: ${\mathbf{D}}\left(\mathit{i}\right)$ must be set to the value of ${D}_{\mathit{i}}\left(x,t,U,{U}_{x}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 9: $\mathrm{S}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: ${\mathbf{S}}\left(\mathit{i}\right)$ must be set to the value of ${S}_{\mathit{i}}\left(x,t,U\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 10: $\mathrm{IRES}$ – INTEGERInput/Output

On entry: set to $1\text{ or}1$.
On exit: should usually remain unchanged. However, you may set
IRES to force the integration routine to take certain actions as described below:
 ${\mathbf{IRES}}=2$
 Indicates to the integrator that control should be passed back immediately to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{6}}$.
 ${\mathbf{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 ${\mathbf{IRES}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ${\mathbf{IRES}}=3$, then D03PFF returns to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{4}}$.
PDEDEF must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PFF is called. Parameters denoted as
Input must
not be changed by this procedure.
 5: $\mathrm{NUMFLX}$ – SUBROUTINE, supplied by the user.External Procedure

NUMFLX must supply the numerical flux for each PDE given the
left and
right values of the solution vector
${\mathbf{U}}$.
NUMFLX is called approximately midway between each pair of mesh points in turn by D03PFF.
The specification of
NUMFLX is:
INTEGER 
NPDE, IRES 
REAL (KIND=nag_wp) 
T, X, ULEFT(NPDE), URIGHT(NPDE), FLUX(NPDE) 

 1: $\mathrm{NPDE}$ – INTEGERInput

On entry: the number of PDEs in the system.
 2: $\mathrm{T}$ – REAL (KIND=nag_wp)Input

On entry: the current value of the independent variable $t$.
 3: $\mathrm{X}$ – REAL (KIND=nag_wp)Input

On entry: the current value of the space variable $x$.
 4: $\mathrm{ULEFT}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: ${\mathbf{ULEFT}}\left(\mathit{i}\right)$ contains the left value of the component ${U}_{\mathit{i}}\left(x\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 5: $\mathrm{URIGHT}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: ${\mathbf{URIGHT}}\left(\mathit{i}\right)$ contains the right value of the component ${U}_{\mathit{i}}\left(x\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 6: $\mathrm{FLUX}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit: ${\mathbf{FLUX}}\left(\mathit{i}\right)$ must be set to the numerical flux ${\hat{F}}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 7: $\mathrm{IRES}$ – INTEGERInput/Output

On entry: set to $1\text{ or}1$.
On exit: should usually remain unchanged. However, you may set
IRES to force the integration routine to take certain actions as described below:
 ${\mathbf{IRES}}=2$
 Indicates to the integrator that control should be passed back immediately to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{6}}$.
 ${\mathbf{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 ${\mathbf{IRES}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ${\mathbf{IRES}}=3$, then D03PFF returns to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{4}}$.
NUMFLX must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PFF is called. Parameters denoted as
Input must
not be changed by this procedure.
 6: $\mathrm{BNDARY}$ – SUBROUTINE, supplied by the user.External Procedure

BNDARY must evaluate the functions
${G}_{i}^{L}$ and
${G}_{i}^{R}$ which describe the physical and numerical boundary conditions, as given by
(6) and
(7).
The specification of
BNDARY is:
INTEGER 
NPDE, NPTS, IBND, IRES 
REAL (KIND=nag_wp) 
T, X(NPTS), U(NPDE,3), G(NPDE) 

 1: $\mathrm{NPDE}$ – INTEGERInput

On entry: the number of PDEs in the system.
 2: $\mathrm{NPTS}$ – INTEGERInput

On entry: the number of mesh points in the interval $\left[a,b\right]$.
 3: $\mathrm{T}$ – REAL (KIND=nag_wp)Input

On entry: the current value of the independent variable $t$.
 4: $\mathrm{X}\left({\mathbf{NPTS}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the mesh points in the spatial direction. ${\mathbf{X}}\left(1\right)$ corresponds to the lefthand boundary, $a$, and ${\mathbf{X}}\left({\mathbf{NPTS}}\right)$ corresponds to the righthand boundary, $b$.
 5: $\mathrm{U}\left({\mathbf{NPDE}},3\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: contains the value of solution components in the boundary region.
If ${\mathbf{IBND}}=0$, ${\mathbf{U}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component ${U}_{\mathit{i}}\left(\mathrm{x},t\right)$ at $x={\mathbf{X}}\left(\mathit{j}\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$ and $\mathit{j}=1,2,3$.
If ${\mathbf{IBND}}\ne 0$, ${\mathbf{U}}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{X}}\left({\mathbf{NPTS}}\mathit{j}+1\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$ and $\mathit{j}=1,2,3$.
 6: $\mathrm{IBND}$ – INTEGERInput

On entry: specifies which boundary conditions are to be evaluated.
 ${\mathbf{IBND}}=0$
 BNDARY must evaluate the lefthand boundary condition at $x=a$.
 ${\mathbf{IBND}}\ne 0$
 BNDARY must evaluate the righthand boundary condition at $x=b$.
 7: $\mathrm{G}\left({\mathbf{NPDE}}\right)$ – REAL (KIND=nag_wp) arrayOutput

On exit:
${\mathbf{G}}\left(\mathit{i}\right)$ must contain the
$\mathit{i}$th component of either
${{\mathbf{G}}}^{L}$ or
${{\mathbf{G}}}^{R}$ in
(6) and
(7), depending on the value of
IBND, for
$\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$.
 8: $\mathrm{IRES}$ – INTEGERInput/Output

On entry: set to $1\text{ or}1$.
On exit: should usually remain unchanged. However, you may set
IRES to force the integration routine to take certain actions as described below:
 ${\mathbf{IRES}}=2$
 Indicates to the integrator that control should be passed back immediately to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{6}}$.
 ${\mathbf{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 ${\mathbf{IRES}}=3$ when a physically meaningless input or output value has been generated. If you consecutively set ${\mathbf{IRES}}=3$, then D03PFF returns to the calling subroutine with the error indicator set to ${\mathbf{IFAIL}}={\mathbf{4}}$.
BNDARY must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D03PFF is called. Parameters denoted as
Input must
not be changed by this procedure.
 7: $\mathrm{U}\left({\mathbf{NPDE}},{\mathbf{NPTS}}\right)$ – REAL (KIND=nag_wp) arrayInput/Output

On entry: ${\mathbf{U}}\left(\mathit{i},\mathit{j}\right)$ must contain the initial value of ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{X}}\left(\mathit{j}\right)$ and $t={\mathbf{TS}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{NPTS}}$.
On exit: ${\mathbf{U}}\left(\mathit{i},\mathit{j}\right)$ will contain the computed solution ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{X}}\left(\mathit{j}\right)$ and $t={\mathbf{TS}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{NPDE}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{NPTS}}$.
 8: $\mathrm{NPTS}$ – INTEGERInput

On entry: the number of mesh points in the interval $\left[a,b\right]$.
Constraint:
${\mathbf{NPTS}}\ge 3$.
 9: $\mathrm{X}\left({\mathbf{NPTS}}\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the mesh points in the space direction. ${\mathbf{X}}\left(1\right)$ must specify the lefthand boundary, $a$, and ${\mathbf{X}}\left({\mathbf{NPTS}}\right)$ must specify the righthand boundary, $b$.
Constraint:
${\mathbf{X}}\left(1\right)<{\mathbf{X}}\left(2\right)<\cdots <{\mathbf{X}}\left({\mathbf{NPTS}}\right)$.
 10: $\mathrm{ACC}\left(2\right)$ – REAL (KIND=nag_wp) arrayInput

On entry: the components of
ACC contain the relative and absolute error tolerances used in the local error test in the time integration.
If
$\mathrm{E}\left(i,j\right)$ is the estimated error for
${U}_{i}$ at the
$j$th mesh point, the error test is
Constraint:
${\mathbf{ACC}}\left(1\right)$ and ${\mathbf{ACC}}\left(2\right)\ge 0.0$ (but not both zero).
 11: $\mathrm{TSMAX}$ – REAL (KIND=nag_wp)Input

On entry: the maximum absolute step size to be allowed in the time integration. If ${\mathbf{TSMAX}}=0.0$ then no maximum is imposed.
Constraint:
${\mathbf{TSMAX}}\ge 0.0$.
 12: $\mathrm{RSAVE}\left({\mathbf{LRSAVE}}\right)$ – REAL (KIND=nag_wp) arrayCommunication Array

If
${\mathbf{IND}}=0$,
RSAVE need not be set on entry.
If
${\mathbf{IND}}=1$,
RSAVE must be unchanged from the previous call to the routine because it contains required information about the iteration.
 13: $\mathrm{LRSAVE}$ – INTEGERInput

On entry: the dimension of the array
RSAVE as declared in the (sub)program from which D03PFF is called.
Constraint:
${\mathbf{LRSAVE}}\ge \left(11+9\times {\mathbf{NPDE}}\right)\times {\mathbf{NPDE}}\times {\mathbf{NPTS}}+\left(32+3\times {\mathbf{NPDE}}\right)\times {\mathbf{NPDE}}+7\times \phantom{\rule{0ex}{0ex}}{\mathbf{NPTS}}+54$.
 14: $\mathrm{ISAVE}\left({\mathbf{LISAVE}}\right)$ – INTEGER arrayCommunication Array

If
${\mathbf{IND}}=0$,
ISAVE need not be set on entry.
If
${\mathbf{IND}}=1$,
ISAVE must be unchanged from the previous call to the routine because it contains required information about the iteration. In particular:
 ${\mathbf{ISAVE}}\left(1\right)$
 Contains the number of steps taken in time.
 ${\mathbf{ISAVE}}\left(2\right)$
 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.
 ${\mathbf{ISAVE}}\left(3\right)$
 Contains the number of Jacobian evaluations performed by the time integrator.
 ${\mathbf{ISAVE}}\left(4\right)$
 Contains the order of the last backward differentiation formula method used.
 ${\mathbf{ISAVE}}\left(5\right)$
 Contains the number of Newton iterations performed by the time integrator. Each iteration involves an ODE residual evaluation followed by a backsubstitution using the $LU$ decomposition of the Jacobian matrix.
 15: $\mathrm{LISAVE}$ – INTEGERInput

On entry: the dimension of the array
ISAVE as declared in the (sub)program from which D03PFF is called.
Constraint:
${\mathbf{LISAVE}}\ge {\mathbf{NPDE}}\times {\mathbf{NPTS}}+24$.
 16: $\mathrm{ITASK}$ – INTEGERInput

On entry: the task to be performed by the ODE integrator.
 ${\mathbf{ITASK}}=1$
 Normal computation of output values ${\mathbf{U}}$ at $t={\mathbf{TOUT}}$ (by overshooting and interpolating).
 ${\mathbf{ITASK}}=2$
 Take one step in the time direction and return.
 ${\mathbf{ITASK}}=3$
 Stop at first internal integration point at or beyond $t={\mathbf{TOUT}}$.
Constraint:
${\mathbf{ITASK}}=1$, $2$ or $3$.
 17: $\mathrm{ITRACE}$ – INTEGERInput

On entry: the level of trace information required from D03PFF and the underlying ODE solver.
ITRACE may take the value
$1$,
$0$,
$1$,
$2$ or
$3$.
 ${\mathbf{ITRACE}}=1$
 No output is generated.
 ${\mathbf{ITRACE}}=0$
 Only warning messages from the PDE solver are printed on the current error message unit (see X04AAF).
 ${\mathbf{ITRACE}}>0$
 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 ${\mathbf{ITRACE}}<1$, then $1$ is assumed and similarly if ${\mathbf{ITRACE}}>3$, then $3$ is assumed.
The advisory messages are given in greater detail as
ITRACE increases. You are advised to set
${\mathbf{ITRACE}}=0$, unless you are experienced with
subchapter D02M–N.
 18: $\mathrm{IND}$ – INTEGERInput/Output

On entry: indicates whether this is a continuation call or a new integration.
 ${\mathbf{IND}}=0$
 Starts or restarts the integration in time.
 ${\mathbf{IND}}=1$
 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 D03PFF.
Constraint:
${\mathbf{IND}}=0$ or $1$.
On exit: ${\mathbf{IND}}=1$.
 19: $\mathrm{IFAIL}$ – INTEGERInput/Output

On entry:
IFAIL must be set to
$0$,
$1\text{ or}1$. 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
$1\text{ or}1$ is recommended. If the output of error messages is undesirable, then the value
$1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is
$0$.
When the value $\mathbf{1}\text{ or}\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.
On exit:
${\mathbf{IFAIL}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see
Section 6).
6 Error Indicators and Warnings
If on entry
${\mathbf{IFAIL}}={\mathbf{0}}$ or
${{\mathbf{1}}}$, explanatory error messages are output on the current error message unit (as defined by
X04AAF).
Errors or warnings detected by the routine:
 ${\mathbf{IFAIL}}=1$

On entry,  ${\mathbf{TS}}\ge {\mathbf{TOUT}}$, 
or  ${\mathbf{TOUT}}{\mathbf{TS}}$ is too small, 
or  ${\mathbf{ITASK}}=1$, $2$ or $3$, 
or  ${\mathbf{NPTS}}<3$, 
or  ${\mathbf{NPDE}}<1$, 
or  ${\mathbf{IND}}\ne 0$ or $1$, 
or  incorrect userdefined mesh, i.e., ${\mathbf{X}}\left(i\right)\ge {\mathbf{X}}\left(i+1\right)$ for some $i=1,2,\dots ,{\mathbf{NPTS}}1$, 
or  LRSAVE or LISAVE are too small, 
or  ${\mathbf{IND}}=1$ on initial entry to D03PFF, 
or  ${\mathbf{ACC}}\left(1\right)$ or ${\mathbf{ACC}}\left(2\right)<0.0$, 
or  ${\mathbf{ACC}}\left(1\right)$ or ${\mathbf{ACC}}\left(2\right)$ are both zero, 
or  ${\mathbf{TSMAX}}<0.0$. 
 ${\mathbf{IFAIL}}=2$

The underlying ODE solver cannot make any further progress, with the values of
ACC, across the integration range from the current point
$t={\mathbf{TS}}$. The components of
U contain the computed values at the current point
$t={\mathbf{TS}}$.
 ${\mathbf{IFAIL}}=3$

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 $t={\mathbf{TS}}$. The problem may have a singularity, or the error requirement may be inappropriate. Incorrect specification of boundary conditions may also result in this error.
 ${\mathbf{IFAIL}}=4$

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
$3$ in one of
PDEDEF,
NUMFLX or
BNDARY when the residual in the underlying ODE solver was being evaluated. Incorrect specification of boundary conditions may also result in this error.
 ${\mathbf{IFAIL}}=5$

In solving the ODE system, a singular Jacobian has been encountered. Check the problem formulation.
 ${\mathbf{IFAIL}}=6$

When evaluating the residual in solving the ODE system,
IRES was set to
$2$ in at least one of
PDEDEF,
NUMFLX or
BNDARY. Integration was successful as far as
$t={\mathbf{TS}}$.
 ${\mathbf{IFAIL}}=7$

The values of ${\mathbf{ACC}}\left(1\right)$ and ${\mathbf{ACC}}\left(2\right)$ are so small that the routine is unable to start the integration in time.
 ${\mathbf{IFAIL}}=8$

In either,
PDEDEF,
NUMFLX or
BNDARY,
IRES was set to an invalid value.
 ${\mathbf{IFAIL}}=9$ (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
${\mathbf{ITRACE}}=1$ may provide more information. If the problem persists, contact
NAG.
 ${\mathbf{IFAIL}}=10$

The required task has been completed, but it is estimated that a small change in the values of
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
${\mathbf{ITASK}}\ne 2$.)
 ${\mathbf{IFAIL}}=11$

An error occurred during Jacobian formulation of the ODE system (a more detailed error description may be directed to the current advisory message unit when ${\mathbf{ITRACE}}\ge 1$).
 ${\mathbf{IFAIL}}=12$

Not applicable.
 ${\mathbf{IFAIL}}=13$

Not applicable.
 ${\mathbf{IFAIL}}=14$

One or more of the functions ${P}_{i,j}$, ${D}_{i}$ or ${C}_{i}$ was detected as depending on time derivatives, which is not permissible.
 ${\mathbf{IFAIL}}=99$
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 3.8 in the Essential Introduction for further information.
 ${\mathbf{IFAIL}}=399$
Your licence key may have expired or may not have been installed correctly.
See
Section 3.7 in the Essential Introduction for further information.
 ${\mathbf{IFAIL}}=999$
Dynamic memory allocation failed.
See
Section 3.6 in the Essential Introduction for further information.
7 Accuracy
D03PFF 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 components of the accuracy parameter,
ACC.
8 Parallelism and Performance
D03PFF is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
D03PFF 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 implementationspecific information.
D03PFF is designed to solve systems of PDEs in conservative form, with optional source terms which are independent of space derivatives, and optional secondorder diffusion terms. The use of the routine to solve systems which are not naturally in this form is discouraged, and you are advised to use one of the centraldifference schemes for such problems.
You should be aware of the stability limitations for hyperbolic PDEs. For most problems with small error tolerances the ODE integrator does not attempt unstable time steps, but in some cases a maximum time step should be imposed using
TSMAX. It is worth experimenting with this parameter, particularly if the integration appears to progress unrealistically fast (with large time steps). Setting the maximum time step to the minimum mesh size is a safe measure, although in some cases this may be too restrictive.
Problems with source terms should be treated with caution, as it is known that for large source terms stable and reasonable looking solutions can be obtained which are in fact incorrect, exhibiting nonphysical speeds of propagation of discontinuities (typically one spatial mesh point per time step). It is essential to employ a very fine mesh for problems with source terms and discontinuities, and to check for nonphysical propagation speeds by comparing results for different mesh sizes. Further details and an example can be found in
Pennington and Berzins (1994).
The time taken depends on the complexity of the system and on the accuracy requested.
10 Example
For this routine two examples are presented. There is a single example program for D03PFF, with a main program and the code to solve the two example problems given in Example 1 (EX1) and Example 2 (EX2).
Example 1 (EX1)
This example is a simple firstorder system which illustrates the calculation of the numerical flux using Roe's approximate Riemann solver, and the specification of numerical boundary conditions using extrapolated characteristic variables. The PDEs are
for
$x\in \left[0,1\right]$ and
$t\ge 0$. The PDEs have an exact solution given by
The initial conditions are given by the exact solution. The characteristic variables are
$2{U}_{1}+{U}_{2}$ and
$2{U}_{1}{U}_{2}$ corresponding to the characteristics given by
$dx/dt=3$ and
$dx/dt=1$ respectively. Hence a physical boundary condition is required for
$2{U}_{1}+{U}_{2}$ at the lefthand boundary, and for
$2{U}_{1}{U}_{2}$ at the righthand boundary (corresponding to the incoming characteristics); and a numerical boundary condition is required for
$2{U}_{1}{U}_{2}$ at the lefthand boundary, and for
$2{U}_{1}+{U}_{2}$ at the righthand boundary (outgoing characteristics). The physical boundary conditions are obtained from the exact solution, and the numerical boundary conditions are calculated by linear extrapolation of the appropriate characteristic variable. The numerical flux is calculated using Roe's approximate Riemann solver: Using the notation in
Section 3, the flux vector
$F$ and the Jacobian matrix
$A$ are
and the eigenvalues of
$A$ are
$3$ and
$1$ with right eigenvectors
${\left[\begin{array}{cc}1& 2\end{array}\right]}^{\mathrm{T}}$ and
${\left[\begin{array}{cc}1& 2\end{array}\right]}^{\mathrm{T}}$ respectively. Using equation
(4) the
${\alpha}_{k}$ are given by
that is
${F}_{L}$ is given by
and similarly for
${F}_{R}$. From equation
(4), the numerical flux vector is
that is
Example 2 (EX2)
This example is an advectiondiffusion equation in which the flux term depends explicitly on
$x$:
for
$x\in \left[1,1\right]$ and
$0\le t\le 10$. The parameter
$\epsilon $ is taken to be
$0.01$. The two physical boundary conditions are
$U\left(1,t\right)=3.0$ and
$U\left(1,t\right)=5.0$ and the initial condition is
$U\left(x,0\right)=x+4$. The integration is run to steady state at which the solution is known to be
$U=4$ across the domain with a narrow boundary layer at both boundaries. In order to write the PDE in conservative form, a source term must be introduced, i.e.,
As in Example 1, the numerical flux is calculated using the Roe approximate Riemann solver. The Riemann problem to solve locally is
The
$x$ in the flux term is assumed to be constant at a local level, and so using the notation in
Section 3,
$F=xU$ and
$A=x$. The eigenvalue is
$x$ and the eigenvector (a scalar in this case) is
$1$. The numerical flux is therefore
10.1 Program Text
Program Text (d03pffe.f90)
10.2 Program Data
Program Data (d03pffe.d)
10.3 Program Results
Program Results (d03pffe.r)