NAG CL Interfaced03pfc (dim1_​parab_​convdiff)

Settings help

CL Name Style:

1Purpose

d03pfc integrates a system of linear or nonlinear convection-diffusion 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 user-supplied 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.

2Specification

 #include
void  d03pfc (Integer npde, double *ts, double tout,
 void (*pdedef)(Integer npde, double t, double x, const double u[], const double ux[], double p[], double c[], double d[], double s[], Integer *ires, Nag_Comm *comm),
 void (*numflx)(Integer npde, double t, double x, const double uleft[], const double uright[], double flux[], Integer *ires, Nag_Comm *comm, Nag_D03_Save *saved),
 void (*bndary)(Integer npde, Integer npts, double t, const double x[], const double u[], Integer ibnd, double g[], Integer *ires, Nag_Comm *comm),
double u[], Integer npts, const double x[], const double acc[], double tsmax, 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: d03pfc, nag_pde_dim1_parab_convdiff or nag_pde_parab_1d_cd.

3Description

d03pfc integrates the system of convection-diffusion equations in conservative form:
 $∑j=1npdePi,j ∂Uj ∂t + ∂Fi ∂x =Ci ∂Di ∂x +Si,$ (1)
or the hyperbolic convection-only system:
 $∂Ui ∂t + ∂Fi ∂x =0,$ (2)
for $i=1,2,\dots ,{\mathbf{npde}}\text{, }a\le x\le b\text{, }t\ge {t}_{0}$, where the vector $U$ is the set of solution values
 $U (x,t) = [ U 1 (x,t) ,…, U npde (x,t) ] T .$
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 user-defined 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 central-difference scheme used in d03pcc, d03phc and d03ppc, 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, ${\stackrel{^}{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 mid-point of the mesh ${x}_{j-1/2}=\left({x}_{j-1}+{x}_{j}\right)/2$, for $j=2,3,\dots ,{\mathbf{npts}}$. The left and right values are calculated by d03pfc from two adjacent mesh points using a standard upwind technique combined with a Van Leer slope-limiter (see LeVeque (1990)). The physically correct value for ${\stackrel{^}{F}}_{i}$ is derived from the solution of the Riemann problem given by
 $∂Ui ∂t + ∂Fi ∂y =0,$ (3)
where $y=x-{x}_{j-1/2}$, i.e., $y=0$ corresponds to $x={x}_{j-1/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 $\stackrel{^}{F}$ is given by
 $F^=12 (FL+FR)-12∑k=1npdeαk|λk|ek,$ (4)
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
 $UR-UL=∑k=1npdeαkek.$ (5)
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 ${\stackrel{^}{F}}_{i}$ must be supplied in a separate numflx. For problems in the form (2)) the NAG defined null void function pointer, NULLFN, can be supplied in the call to d03pfc.
The boundary condition specification has sufficient flexibility to allow for different types of problems. For second-order 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 well-posed. If there are no second-order 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 first-order 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 function (for greater flexibility the function d03plc 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.
The boundary conditions must be specified in bndary in the form
 $GiL(x,t,U)=0 at ​x=a, i=1,2,…,npde,$ (6)
at the left-hand boundary, and
 $GiR(x,t,U)=0 at ​x=b, i=1,2,…,npde,$ (7)
at the right-hand 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 one-sided differencing opposes the characteristic direction at the boundary.
The problem is subject to the following restrictions:
1. (i)${P}_{i,j}$, ${F}_{i}$, ${C}_{i}$ and ${S}_{i}$ must not depend on any space derivatives;
2. (ii)${P}_{i,j}$, ${F}_{i}$, ${C}_{i}$, ${D}_{i}$ and ${S}_{i}$ must not depend on any time derivatives;
3. (iii)${t}_{0}<{t}_{\mathrm{out}}$, so that integration is in the forward direction;
4. (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}}}$;
5. (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}}×{\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.

4References

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
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 first-order 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

5Arguments

1: $\mathbf{npde}$Integer Input
On entry: the number of PDEs to be solved.
Constraint: ${\mathbf{npde}}\ge 1$.
2: $\mathbf{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 ${\mathbf{ts}}={\mathbf{tout}}$.
Constraint: ${\mathbf{ts}}<{\mathbf{tout}}$.
3: $\mathbf{tout}$double Input
On entry: the final value of $t$ to which the integration is to be carried out.
4: $\mathbf{pdedef}$function, supplied by the user External Function
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 d03pfc. For problems in the form (2)) the NAG defined null void function pointer, NULLFN, can be supplied in the call to d03pfc.
The specification of pdedef is:
 void pdedef (Integer npde, double t, double x, const double u[], const double ux[], double p[], double c[], double d[], double s[], Integer *ires, Nag_Comm *comm)
1: $\mathbf{npde}$Integer Input
On entry: the number of PDEs in the system.
2: $\mathbf{t}$double Input
On entry: the current value of the independent variable $t$.
3: $\mathbf{x}$double Input
On entry: the current value of the space variable $x$.
4: $\mathbf{u}\left[{\mathbf{npde}}\right]$const double Input
On entry: ${\mathbf{u}}\left[\mathit{i}-1\right]$ contains the value of the component ${U}_{\mathit{i}}\left(x,t\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
5: $\mathbf{ux}\left[{\mathbf{npde}}\right]$const double Input
On entry: ${\mathbf{ux}}\left[\mathit{i}-1\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: $\mathbf{p}\left[{\mathbf{npde}}×{\mathbf{npde}}\right]$double Output
Note: the $\left(i,j\right)$th element of the matrix $P$ is stored in ${\mathbf{p}}\left[\left(j-1\right)×{\mathbf{npde}}+i-1\right]$.
On exit: ${\mathbf{p}}\left[\left(\mathit{j}-1\right)×{\mathbf{npde}}+\mathit{i}-1\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: $\mathbf{c}\left[{\mathbf{npde}}\right]$double Output
On exit: ${\mathbf{c}}\left[\mathit{i}-1\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: $\mathbf{d}\left[{\mathbf{npde}}\right]$double Output
On exit: ${\mathbf{d}}\left[\mathit{i}-1\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: $\mathbf{s}\left[{\mathbf{npde}}\right]$double Output
On exit: ${\mathbf{s}}\left[\mathit{i}-1\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: $\mathbf{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:
${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_USER_STOP.
${\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$, d03pfc returns to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_FAILED_DERIV.
11: $\mathbf{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 d03pfc you may allocate memory and initialize these pointers with various quantities for use by pdedef when called from d03pfc (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 d03pfc. If your code inadvertently does return any NaNs or infinities, d03pfc is likely to produce unexpected results.
5: $\mathbf{numflx}$function, supplied by the user External Function
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 d03pfc.
The specification of numflx is:
 void numflx (Integer npde, double t, double x, const double uleft[], const double uright[], double flux[], Integer *ires, Nag_Comm *comm, Nag_D03_Save *saved)
1: $\mathbf{npde}$Integer Input
On entry: the number of PDEs in the system.
2: $\mathbf{t}$double Input
On entry: the current value of the independent variable $t$.
3: $\mathbf{x}$double Input
On entry: the current value of the space variable $x$.
4: $\mathbf{uleft}\left[{\mathbf{npde}}\right]$const double Input
On entry: ${\mathbf{uleft}}\left[\mathit{i}-1\right]$ contains the left value of the component ${U}_{\mathit{i}}\left(x\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
5: $\mathbf{uright}\left[{\mathbf{npde}}\right]$const double Input
On entry: ${\mathbf{uright}}\left[\mathit{i}-1\right]$ contains the right value of the component ${U}_{\mathit{i}}\left(x\right)$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
6: $\mathbf{flux}\left[{\mathbf{npde}}\right]$double Output
On exit: ${\mathbf{flux}}\left[\mathit{i}-1\right]$ must be set to the numerical flux ${\stackrel{^}{F}}_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$.
7: $\mathbf{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:
${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_USER_STOP.
${\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$, d03pfc returns to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_FAILED_DERIV.
8: $\mathbf{comm}$Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to numflx.
userdouble *
iuserInteger *
pPointer
The type Pointer will be void *. Before calling d03pfc you may allocate memory and initialize these pointers with various quantities for use by numflx when called from d03pfc (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
9: $\mathbf{saved}$Nag_D03_Save * Communication Structure
If numflx calls one of the approximate Riemann solvers d03puc, d03pvc, d03pwc or d03pxc then saved is used to pass data concerning the computation to the solver. You should not change the components of saved.
Note: numflx should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pfc. If your code inadvertently does return any NaNs or infinities, d03pfc is likely to produce unexpected results.
6: $\mathbf{bndary}$function, supplied by the user External Function
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:
 void bndary (Integer npde, Integer npts, double t, const double x[], const double u[], Integer ibnd, double g[], Integer *ires, Nag_Comm *comm)
1: $\mathbf{npde}$Integer Input
On entry: the number of PDEs in the system.
2: $\mathbf{npts}$Integer Input
On entry: the number of mesh points in the interval $\left[a,b\right]$.
3: $\mathbf{t}$double Input
On entry: the current value of the independent variable $t$.
4: $\mathbf{x}\left[{\mathbf{npts}}\right]$const double Input
On entry: the mesh points in the spatial direction. ${\mathbf{x}}\left[0\right]$ corresponds to the left-hand boundary, $a$, and ${\mathbf{x}}\left[{\mathbf{npts}}-1\right]$ corresponds to the right-hand boundary, $b$.
5: $\mathbf{u}\left[{\mathbf{npde}}×3\right]$const double Input
Note: the $\left(i,j\right)$th element of the matrix $U$ is stored in ${\mathbf{u}}\left[\left(j-1\right)×{\mathbf{npde}}+i-1\right]$.
On entry: contains the value of solution components in the boundary region.
If ${\mathbf{ibnd}}=0$, ${\mathbf{u}}\left[\left(\mathit{j}-1\right)×{\mathbf{npde}}+\mathit{i}-1\right]$ contains the value of the component ${U}_{\mathit{i}}\left(\mathrm{x},t\right)$ at $x={\mathbf{x}}\left[\mathit{j}-1\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and $\mathit{j}=1,2,3$.
If ${\mathbf{ibnd}}\ne 0$, ${\mathbf{u}}\left[\left(\mathit{j}-1\right)×{\mathbf{npde}}+\mathit{i}-1\right]$ contains the value of the component ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{x}}\left[{\mathbf{npts}}-\mathit{j}\right]$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and $\mathit{j}=1,2,3$.
6: $\mathbf{ibnd}$Integer Input
On entry: specifies which boundary conditions are to be evaluated.
${\mathbf{ibnd}}=0$
bndary must evaluate the left-hand boundary condition at $x=a$.
${\mathbf{ibnd}}\ne 0$
bndary must evaluate the right-hand boundary condition at $x=b$.
7: $\mathbf{g}\left[{\mathbf{npde}}\right]$double Output
On exit: ${\mathbf{g}}\left[\mathit{i}-1\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: $\mathbf{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:
${\mathbf{ires}}=2$
Indicates to the integrator that control should be passed back immediately to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_USER_STOP.
${\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$, d03pfc returns to the calling function with the error indicator set to ${\mathbf{fail}}\mathbf{.}\mathbf{code}=$ NE_FAILED_DERIV.
9: $\mathbf{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 d03pfc you may allocate memory and initialize these pointers with various quantities for use by bndary when called from d03pfc (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 d03pfc. If your code inadvertently does return any NaNs or infinities, d03pfc is likely to produce unexpected results.
7: $\mathbf{u}\left[{\mathbf{npde}}×{\mathbf{npts}}\right]$double Input/Output
Note: the $\left(i,j\right)$th element of the matrix $U$ is stored in ${\mathbf{u}}\left[\left(j-1\right)×{\mathbf{npde}}+i-1\right]$.
On entry: ${\mathbf{u}}\left[\left(\mathit{j}-1\right)×{\mathbf{npde}}+\mathit{i}-1\right]$ must contain the initial value of ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{x}}\left[\mathit{j}-1\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[\left(\mathit{j}-1\right)×{\mathbf{npde}}+\mathit{i}-1\right]$ will contain the computed solution ${U}_{\mathit{i}}\left(x,t\right)$ at $x={\mathbf{x}}\left[\mathit{j}-1\right]$ and $t={\mathbf{ts}}$, for $\mathit{i}=1,2,\dots ,{\mathbf{npde}}$ and $\mathit{j}=1,2,\dots ,{\mathbf{npts}}$.
8: $\mathbf{npts}$Integer Input
On entry: the number of mesh points in the interval $\left[a,b\right]$.
Constraint: ${\mathbf{npts}}\ge 3$.
9: $\mathbf{x}\left[{\mathbf{npts}}\right]$const double Input
On entry: the mesh points in the space direction. ${\mathbf{x}}\left[0\right]$ must specify the left-hand boundary, $a$, and ${\mathbf{x}}\left[{\mathbf{npts}}-1\right]$ must specify the right-hand boundary, $b$.
Constraint: ${\mathbf{x}}\left[0\right]<{\mathbf{x}}\left[1\right]<\cdots <{\mathbf{x}}\left[{\mathbf{npts}}-1\right]$.
10: $\mathbf{acc}\left[2\right]$const double Input
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
 $E(i,j)=acc[0]×u[(j-1)×npde+i-1]+acc[1].$
Constraint: ${\mathbf{acc}}\left[0\right]$ and ${\mathbf{acc}}\left[1\right]\ge 0.0$ (but not both zero).
11: $\mathbf{tsmax}$double 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: $\mathbf{rsave}\left[{\mathbf{lrsave}}\right]$double Communication 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 function because it contains required information about the iteration.
13: $\mathbf{lrsave}$Integer Input
On entry: the dimension of the array rsave.
Constraint: ${\mathbf{lrsave}}\ge \left(11+9×{\mathbf{npde}}\right)×{\mathbf{npde}}×{\mathbf{npts}}+\left(32+3×{\mathbf{npde}}\right)×{\mathbf{npde}}+7×\phantom{\rule{0ex}{0ex}}{\mathbf{npts}}+54$.
14: $\mathbf{isave}\left[{\mathbf{lisave}}\right]$Integer Communication 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 function because it contains required information about the iteration. In particular:
${\mathbf{isave}}\left[0\right]$
Contains the number of steps taken in time.
${\mathbf{isave}}\left[1\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[2\right]$
Contains the number of Jacobian evaluations performed by the time integrator.
${\mathbf{isave}}\left[3\right]$
Contains the order of the last backward differentiation formula method used.
${\mathbf{isave}}\left[4\right]$
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.
15: $\mathbf{lisave}$Integer Input
On entry: the dimension of the array isave.
Constraint: ${\mathbf{lisave}}\ge {\mathbf{npde}}×{\mathbf{npts}}+24$.
16: $\mathbf{itask}$Integer Input
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: $\mathbf{itrace}$Integer Input
On entry: the level of trace information required from d03pfc 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.
${\mathbf{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 ${\mathbf{itrace}}<-1$, $-1$ is assumed and similarly if ${\mathbf{itrace}}>3$, $3$ is assumed.
The advisory messages are given in greater detail as itrace increases.
18: $\mathbf{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.
19: $\mathbf{ind}$Integer * Input/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 function. In this case, only the argument tout should be reset between calls to d03pfc.
Constraint: ${\mathbf{ind}}=0$ or $1$.
On exit: ${\mathbf{ind}}=1$.
20: $\mathbf{comm}$Nag_Comm *
The NAG communication argument (see Section 3.1.1 in the Introduction to the NAG Library CL Interface).
21: $\mathbf{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.
22: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6Error Indicators and Warnings

NE_ACC_IN_DOUBT
Integration completed, but small changes in acc are unlikely to result in a changed solution. ${\mathbf{acc}}\left[0\right]=⟨\mathit{\text{value}}⟩$, ${\mathbf{acc}}\left[1\right]=⟨\mathit{\text{value}}⟩$.
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$.)
NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
On entry, argument $⟨\mathit{\text{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 ${\mathbf{ires}}=3$ in pdedef, numflx, or bndary.
NE_FAILED_START
Values in acc are too small to start integration: ${\mathbf{acc}}\left[0\right]=⟨\mathit{\text{value}}⟩$, ${\mathbf{acc}}\left[1\right]=⟨\mathit{\text{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: ${\mathbf{ts}}=⟨\mathit{\text{value}}⟩$.
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.
Underlying ODE solver cannot make further progress from the point ts with the supplied values of acc. ${\mathbf{ts}}=⟨\mathit{\text{value}}⟩$, ${\mathbf{acc}}\left[0\right]=⟨\mathit{\text{value}}⟩$, ${\mathbf{acc}}\left[1\right]=⟨\mathit{\text{value}}⟩$.
NE_INCOMPAT_PARAM
On entry, ${\mathbf{acc}}\left[0\right]$ and ${\mathbf{acc}}\left[1\right]$ are both zero.
NE_INT
ires set to an invalid value in call to pdedef, numflx, or bndary.
On entry, ${\mathbf{ind}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{ind}}=0$ or $1$.
On entry, ${\mathbf{itask}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{itask}}=1$, $2$ or $3$.
On entry, ${\mathbf{npde}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{npde}}\ge 1$.
On entry, ${\mathbf{npts}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{npts}}\ge 3$.
On entry, on initial entry ${\mathbf{ind}}=1$.
Constraint: on initial entry ${\mathbf{ind}}=0$.
NE_INT_2
On entry, ${\mathbf{lisave}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lisave}}\ge ⟨\mathit{\text{value}}⟩$.
On entry, ${\mathbf{lrsave}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{lrsave}}\ge ⟨\mathit{\text{value}}⟩$.
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 $⟨\mathit{\text{value}}⟩$.
NE_NOT_STRICTLY_INCREASING
On entry, $\mathit{i}=⟨\mathit{\text{value}}⟩$, ${\mathbf{x}}\left[\mathit{i}-1\right]=⟨\mathit{\text{value}}⟩$, $\mathit{j}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{x}}\left[\mathit{j}-1\right]=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{x}}\left[0\right]<{\mathbf{x}}\left[1\right]<\cdots <{\mathbf{x}}\left[{\mathbf{npts}}-1\right]$.
NE_NOT_WRITE_FILE
Cannot open file $⟨\mathit{\text{value}}⟩$ for writing.
NE_REAL
On entry, ${\mathbf{acc}}\left[0\right]=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{acc}}\left[0\right]\ge 0.0$.
On entry, ${\mathbf{acc}}\left[1\right]=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{acc}}\left[1\right]\ge 0.0$.
On entry, ${\mathbf{tsmax}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{tsmax}}\ge 0.0$.
NE_REAL_2
On entry, ${\mathbf{tout}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{ts}}=⟨\mathit{\text{value}}⟩$.
Constraint: ${\mathbf{tout}}>{\mathbf{ts}}$.
On entry, ${\mathbf{tout}}-{\mathbf{ts}}$ is too small: ${\mathbf{tout}}=⟨\mathit{\text{value}}⟩$ and ${\mathbf{ts}}=⟨\mathit{\text{value}}⟩$.
NE_SING_JAC
Singular Jacobian of ODE system. Check problem formulation.
NE_TIME_DERIV_DEP
The functions $P$, $D$, or $C$ appear to depend on time derivatives.
NE_USER_STOP
In evaluating residual of ODE system, ${\mathbf{ires}}=2$ has been set in pdedef, numflx, or bndary. Integration is successful as far as ts: ${\mathbf{ts}}=⟨\mathit{\text{value}}⟩$.

7Accuracy

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

8Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
d03pfc is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
d03pfc 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.

d03pfc is designed to solve systems of PDEs in conservative form, with optional source terms which are independent of space derivatives, and optional second-order diffusion terms. The use of the function to solve systems which are not naturally in this form is discouraged, and you are advised to use one of the central-difference 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 argument, 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 non-physical 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 non-physical 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.

10Example

For this function two examples are presented. There is a single example program for d03pfc, 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 first-order 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
 $∂U1 ∂t + ∂U1 ∂x + ∂U2 ∂x = 0, ∂U2 ∂t +4 ∂U1 ∂x + ∂U2 ∂x = 0,$
for $x\in \left[0,1\right]$ and $t\ge 0$. The PDEs have an exact solution given by
 $U1 (x,t) = 12 {exp(x+t)+exp(x-3t)} + 14 {sin(2π (x-3t) 2 )-sin(2π (x+t) 2 )} + 2 t2 - 2 x t , U2 (x,t) = exp(x-3t) - exp(x+t) + 12 {sin(2π (x-3t) 2 )+sin(2π (x-3t) 2 )} + x2 + 5 t2 - 2 x t .$
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 left-hand boundary, and for $2{U}_{1}-{U}_{2}$ at the right-hand boundary (corresponding to the incoming characteristics); and a numerical boundary condition is required for $2{U}_{1}-{U}_{2}$ at the left-hand boundary, and for $2{U}_{1}+{U}_{2}$ at the right-hand 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
 $F=[ U1+U2 4U1+U2 ] and A=[ 1 1 4 1 ],$
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
 $[ U1R-U1L U2R-U2L ]=α1 [ 1 2 ]+α2 [ −1 2 ],$
that is
 $α1 = 14 (2U1R-2U1L+U2R-U2L) and α2 = 14 (−2U1R+2U1L+U2R-U2L) .$
${F}_{L}$ is given by
 $FL = [ U1L+U2L 4U1L+U2L ] ,$
and similarly for ${F}_{R}$. From equation (4), the numerical flux vector is
 $F^ = 12 [ U1L+U2L+0U1R+U2R 4U1L+U2L+4U1R+U2R ] - 12 α1 |3| [ 1 2 ] - 12 α2 |-1| [ −1 2 ] ,$
that is
 $F^ = 12 [ 3U1L-0U1R+32U2L+12 U2R 6U1L+ 2U1R+ 3U2L-0U2R ] .$
Example 2 (ex2)
This example is an advection-diffusion equation in which the flux term depends explicitly on $x$:
 $∂U ∂t +x ∂U ∂x =ε ∂2U ∂x2 ,$
for $x\in \left[-1,1\right]$ and $0\le t\le 10$. The argument $\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.,
 $∂U ∂t + ∂(xU) ∂x =ε ∂2U ∂x2 +U.$
As in Example 1, the numerical flux is calculated using the Roe approximate Riemann solver. The Riemann problem to solve locally is
 $∂U ∂t + ∂(xU) ∂x =0.$
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,
 $F^={ xUL if ​x≥0, xUR if ​x<0.$

10.1Program Text

Program Text (d03pfce.c)

None.

10.3Program Results

Program Results (d03pfce.r)