NAG Library Routine Document

d03pjf  (dim1_parab_dae_coll_old)
d03pja (dim1_parab_dae_coll)

1

Purpose

2

Specification

2.1

Specification for d03pjf

2.2

Specification for d03pja

3

Description

4

References

5

Arguments

1:     $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs to be solved.

Constraint: $\mathbf{npde}\ge 1$.

2:     $\mathbf{m}$ – IntegerInput

On entry: the coordinate system used:

$\mathbf{m}=0$

Indicates Cartesian coordinates.

$\mathbf{m}=1$

Indicates cylindrical polar coordinates.

$\mathbf{m}=2$

Indicates spherical polar coordinates.

Constraint: $\mathbf{m}=0$, $1$ or $2$.

3:     $\mathbf{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}$.

4:     $\mathbf{tout}$ – Real (Kind=nag_wp)Input

On entry: the final value of $t$ to which the integration is to be carried out.

5:     $\mathbf{pdedef}$ – Subroutine, supplied by the user.External Procedure

pdedef must compute the functions $P_{i,j}$, $Q_i$ and $R_i$ which define the system of PDEs. The functions may depend on $x$, $t$, $U$, $U_x$ and $V$; $Q_i$ may depend linearly on $\stackrel{.}{V}$. The functions must be evaluated at a set of points.

The specification of pdedef for d03pjf is:

Fortran Interface

Subroutine pdedef ( npde, t, x, nptl, u, ux, nv, v, vdot, p, q, r, ires) Integer, Intent (In) :: npde, nptl, nv Integer, Intent (Inout) :: ires Real (Kind=nag_wp), Intent (In) :: t, x(nptl), u(npde,nptl), ux(npde,nptl), v(nv), vdot(nv) Real (Kind=nag_wp), Intent (Out) :: p(npde,npde,nptl), q(npde,nptl), r(npde,nptl)

C Header Interface

#include <nagmk26.h> void  pdedef (const Integer *npde, const double *t, const double x[], const Integer *nptl, const double u[], const double ux[], const Integer *nv, const double v[], const double vdot[], double p[], double q[], double r[], Integer *ires)

The specification of pdedef for d03pja is:

Fortran Interface

Subroutine pdedef ( npde, t, x, nptl, u, ux, nv, v, vdot, p, q, r, ires, iuser, ruser) Integer, Intent (In) :: npde, nptl, nv Integer, Intent (Inout) :: ires, iuser(*) Real (Kind=nag_wp), Intent (In) :: t, x(nptl), u(npde,nptl), ux(npde,nptl), v(nv), vdot(nv) Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: p(npde,npde,nptl), q(npde,nptl), r(npde,nptl)

C Header Interface

#include <nagmk26.h> void  pdedef (const Integer *npde, const double *t, const double x[], const Integer *nptl, const double u[], const double ux[], const Integer *nv, const double v[], const double vdot[], double p[], double q[], double r[], Integer *ires, Integer iuser[], double ruser[])

1:     $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:     $\mathbf{t}$ – Real (Kind=nag_wp)Input

On entry: the current value of the independent variable $t$.

3:     $\mathbf{x}\left(\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: contains a set of mesh points at which $P_{i,j}$, $Q_i$ and $R_i$ are to be evaluated. $\mathbf{x}\left(1\right)$ and $\mathbf{x}\left(\mathbf{nptl}\right)$ contain successive user-supplied break-points and the elements of the array will satisfy $\mathbf{x}\left(1\right)<\mathbf{x}\left(2\right)<\cdots <\mathbf{x}\left(\mathbf{nptl}\right)$.

4:     $\mathbf{nptl}$ – IntegerInput

On entry: the number of points at which evaluations are required (the value of $\mathbf{npoly}+1$).

5:     $\mathbf{u}\left(\mathbf{npde},\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{u}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component $U_{\mathit{i}}\left(x,t\right)$ where $x=\mathbf{x}\left(\mathit{j}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nptl}$.

6:     $\mathbf{ux}\left(\mathbf{npde},\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{ux}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component $\frac{\partial U_{\mathit{i}}\left(x,t\right)}{\partial x}$ where $x=\mathbf{x}\left(\mathit{j}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nptl}$.

7:     $\mathbf{nv}$ – IntegerInput

On entry: the number of coupled ODEs in the system.

8:     $\mathbf{v}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{v}\left(\mathit{i}\right)$ contains the value of the component $V_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

9:     $\mathbf{vdot}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{vdot}\left(\mathit{i}\right)$ contains the value of component ${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

Note: ${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$, may only appear linearly in $Q_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,\mathbf{npde}$.

10:   $\mathbf{p}\left(\mathbf{npde},\mathbf{npde},\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{p}\left(\mathit{i},\mathit{j},\mathit{k}\right)$ must be set to the value of $P_{\mathit{i},\mathit{j}}\left(x,t,U,U_x,V\right)$ where $x=\mathbf{x}\left(\mathit{k}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$, $\mathit{j}=1,2,\dots ,\mathbf{npde}$ and $\mathit{k}=1,2,\dots ,\mathbf{nptl}$.

11:   $\mathbf{q}\left(\mathbf{npde},\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{q}\left(\mathit{i},\mathit{j}\right)$ must be set to the value of $Q_{\mathit{i}}\left(x,t,U,U_x,V,\stackrel{.}{V}\right)$ where $x=\mathbf{x}\left(\mathit{j}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nptl}$.

12:   $\mathbf{r}\left(\mathbf{npde},\mathbf{nptl}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{r}\left(\mathit{i},\mathit{j}\right)$ must be set to the value of $R_{\mathit{i}}\left(x,t,U,U_x,V\right)$ where $x=\mathbf{x}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nptl}$.

13:   $\mathbf{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 (sub)routine 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$, d03pjf/d03pja returns to the calling subroutine with the error indicator set to $\mathbf{ifail}=\mathbf{4}$.

Note: the following are additional arguments for specific use with d03pja. Users of d03pjf therefore need not read the remainder of this description.

14:   $\mathbf{iuser}\left(*\right)$ – Integer arrayUser Workspace

15:   $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) arrayUser Workspace

pdedef is called with the arguments iuser and ruser as supplied to d03pjf/d03pja. You should use the arrays iuser and ruser to supply information to pdedef.

pdedef must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d03pjf/d03pja is called. Arguments denoted as Input must not be changed by this procedure.

Note: pdedef should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pjf/d03pja. If your code inadvertently does return any NaNs or infinities, d03pjf/d03pja is likely to produce unexpected results.

6:     $\mathbf{bndary}$ – Subroutine, supplied by the user.External Procedure

bndary must compute the functions ${\beta }_i$ and ${\gamma }_i$ which define the boundary conditions as in equation (4).

The specification of bndary for d03pjf is:

Fortran Interface

Subroutine bndary ( npde, t, u, ux, nv, v, vdot, ibnd, beta, gamma, ires) Integer, Intent (In) :: npde, nv, ibnd Integer, Intent (Inout) :: ires Real (Kind=nag_wp), Intent (In) :: t, u(npde), ux(npde), v(nv), vdot(nv) Real (Kind=nag_wp), Intent (Out) :: beta(npde), gamma(npde)

C Header Interface

#include <nagmk26.h> void  bndary (const Integer *npde, const double *t, const double u[], const double ux[], const Integer *nv, const double v[], const double vdot[], const Integer *ibnd, double beta[], double gamma[], Integer *ires)

The specification of bndary for d03pja is:

Fortran Interface

Subroutine bndary ( npde, t, u, ux, nv, v, vdot, ibnd, beta, gamma, ires, iuser, ruser) Integer, Intent (In) :: npde, nv, ibnd Integer, Intent (Inout) :: ires, iuser(*) Real (Kind=nag_wp), Intent (In) :: t, u(npde), ux(npde), v(nv), vdot(nv) Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: beta(npde), gamma(npde)

C Header Interface

#include <nagmk26.h> void  bndary (const Integer *npde, const double *t, const double u[], const double ux[], const Integer *nv, const double v[], const double vdot[], const Integer *ibnd, double beta[], double gamma[], Integer *ires, Integer iuser[], double ruser[])

1:     $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:     $\mathbf{t}$ – Real (Kind=nag_wp)Input

On entry: the current value of the independent variable $t$.

3:     $\mathbf{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)$ at the boundary specified by ibnd, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$.

4:     $\mathbf{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}$ at the boundary specified by ibnd, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$.

5:     $\mathbf{nv}$ – IntegerInput

On entry: the number of coupled ODEs in the system.

6:     $\mathbf{v}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{v}\left(\mathit{i}\right)$ contains the value of the component $V_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

7:     $\mathbf{vdot}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{vdot}\left(\mathit{i}\right)$ contains the value of component ${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

Note: ${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$, may only appear linearly in $Q_{\mathit{j}}$, for $\mathit{j}=1,2,\dots ,\mathbf{npde}$.

8:     $\mathbf{ibnd}$ – IntegerInput

On entry: specifies which boundary conditions are to be evaluated.

$\mathbf{ibnd}=0$

bndary must set up the coefficients of the left-hand boundary, $x=a$.

$\mathbf{ibnd}\ne 0$

bndary must set up the coefficients of the right-hand boundary, $x=b$.

9:     $\mathbf{beta}\left(\mathbf{npde}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{beta}\left(\mathit{i}\right)$ must be set to the value of ${\beta }_{\mathit{i}}\left(x,t\right)$ at the boundary specified by ibnd, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$.

10:   $\mathbf{gamma}\left(\mathbf{npde}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{gamma}\left(\mathit{i}\right)$ must be set to the value of ${\gamma }_{\mathit{i}}\left(x,t,U,U_x,V,\stackrel{.}{V}\right)$ at the boundary specified by ibnd, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$.

11:   $\mathbf{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 (sub)routine 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$, d03pjf/d03pja returns to the calling subroutine with the error indicator set to $\mathbf{ifail}=\mathbf{4}$.

Note: the following are additional arguments for specific use with d03pja. Users of d03pjf therefore need not read the remainder of this description.

12:   $\mathbf{iuser}\left(*\right)$ – Integer arrayUser Workspace

13:   $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) arrayUser Workspace

bndary is called with the arguments iuser and ruser as supplied to d03pjf/d03pja. You should use the arrays iuser and ruser to supply information to bndary.

bndary must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d03pjf/d03pja is called. Arguments denoted as Input must not be changed by this procedure.

Note: bndary should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pjf/d03pja. If your code inadvertently does return any NaNs or infinities, d03pjf/d03pja is likely to produce unexpected results.

7:     $\mathbf{u}\left(\mathbf{neqn}\right)$ – Real (Kind=nag_wp) arrayInput/Output

On entry: if $\mathbf{ind}=1$ the value of u must be unchanged from the previous call.

On exit: the computed solution $U_{\mathit{i}}\left(x_{\mathit{j}},t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{npts}$, and $V_{\mathit{k}}\left(t\right)$, for $\mathit{k}=1,2,\dots ,\mathbf{nv}$, evaluated at $t=\mathbf{ts}$, as follows:

• $\mathbf{u}\left(\mathbf{npde}\times \left(\mathit{j}-1\right)+\mathit{i}\right)$ contain $U_{\mathit{i}}\left(x_{\mathit{j}},t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{npts}$, and
• $\mathbf{u}\left(\mathbf{npts}\times \mathbf{npde}+\mathit{i}\right)$ contain $V_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

8:     $\mathbf{nbkpts}$ – IntegerInput

On entry: the number of break-points in the interval $\left[a,b\right]$.

Constraint: $\mathbf{nbkpts}\ge 2$.

9:     $\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: the values of the break-points in the space direction. $\mathbf{xbkpts}\left(1\right)$ must specify the left-hand boundary, $a$, and $\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)$ must specify the right-hand boundary, $b$.

Constraint: $\mathbf{xbkpts}\left(1\right)<\mathbf{xbkpts}\left(2\right)<\cdots <\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)$.

10:   $\mathbf{npoly}$ – IntegerInput

On entry: the degree of the Chebyshev polynomial to be used in approximating the PDE solution between each pair of break-points.

Constraint: $1\le \mathbf{npoly}\le 49$.

11:   $\mathbf{npts}$ – IntegerInput

On entry: the number of mesh points in the interval $\left[a,b\right]$.

Constraint: $\mathbf{npts}=\left(\mathbf{nbkpts}-1\right)\times \mathbf{npoly}+1$.

12:   $\mathbf{x}\left(\mathbf{npts}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: the mesh points chosen by d03pjf/d03pja in the spatial direction. The values of x will satisfy $\mathbf{x}\left(1\right)<\mathbf{x}\left(2\right)<\cdots <\mathbf{x}\left(\mathbf{npts}\right)$.

13:   $\mathbf{nv}$ – IntegerInput

On entry: the number of coupled ODE components.

Constraint: $\mathbf{nv}\ge 0$.

14:   $\mathbf{odedef}$ – Subroutine, supplied by the NAG Library or the user.External Procedure

odedef must evaluate the functions $F$, which define the system of ODEs, as given in (3).

If you wish to compute the solution of a system of PDEs only ($\mathbf{nv}=0$), odedef must be the dummy routine d03pck for d03pjf (or d53pck for d03pja). d03pck and d53pck are included in the NAG Library.

The specification of odedef for d03pjf is:

Fortran Interface

Subroutine odedef ( npde, t, nv, v, vdot, nxi, xi, ucp, ucpx, rcp, ucpt, ucptx, f, ires) Integer, Intent (In) :: npde, nv, nxi Integer, Intent (Inout) :: ires Real (Kind=nag_wp), Intent (In) :: t, v(nv), vdot(nv), xi(nxi), ucp(npde,nxi), ucpx(npde,nxi), rcp(npde,nxi), ucpt(npde,nxi), ucptx(npde,nxi) Real (Kind=nag_wp), Intent (Out) :: f(nv)

C Header Interface

#include <nagmk26.h> void  odedef (const Integer *npde, const double *t, const Integer *nv, const double v[], const double vdot[], const Integer *nxi, const double xi[], const double ucp[], const double ucpx[], const double rcp[], const double ucpt[], const double ucptx[], double f[], Integer *ires)

The specification of odedef for d03pja is:

Fortran Interface

Subroutine odedef ( npde, t, nv, v, vdot, nxi, xi, ucp, ucpx, rcp, ucpt, ucptx, f, ires, iuser, ruser) Integer, Intent (In) :: npde, nv, nxi Integer, Intent (Inout) :: ires, iuser(*) Real (Kind=nag_wp), Intent (In) :: t, v(nv), vdot(nv), xi(nxi), ucp(npde,nxi), ucpx(npde,nxi), rcp(npde,nxi), ucpt(npde,nxi), ucptx(npde,nxi) Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: f(nv)

C Header Interface

#include <nagmk26.h> void  odedef (const Integer *npde, const double *t, const Integer *nv, const double v[], const double vdot[], const Integer *nxi, const double xi[], const double ucp[], const double ucpx[], const double rcp[], const double ucpt[], const double ucptx[], double f[], Integer *ires, Integer iuser[], double ruser[])

1:     $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:     $\mathbf{t}$ – Real (Kind=nag_wp)Input

On entry: the current value of the independent variable $t$.

3:     $\mathbf{nv}$ – IntegerInput

On entry: the number of coupled ODEs in the system.

4:     $\mathbf{v}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{v}\left(\mathit{i}\right)$ contains the value of the component $V_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

5:     $\mathbf{vdot}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nv}>0$, $\mathbf{vdot}\left(\mathit{i}\right)$ contains the value of component ${\stackrel{.}{V}}_{\mathit{i}}\left(t\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

6:     $\mathbf{nxi}$ – IntegerInput

On entry: the number of ODE/PDE coupling points.

7:     $\mathbf{xi}\left(\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nxi}>0$, $\mathbf{xi}\left(\mathit{i}\right)$ contains the ODE/PDE coupling points, ${\xi }_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathbf{nxi}$.

8:     $\mathbf{ucp}\left(\mathbf{npde},\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nxi}>0$, $\mathbf{ucp}\left(\mathit{i},\mathit{j}\right)$ contains the value of $U_{\mathit{i}}\left(x,t\right)$ at the coupling point $x={\xi }_{\mathit{j}}$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nxi}$.

9:     $\mathbf{ucpx}\left(\mathbf{npde},\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nxi}>0$, $\mathbf{ucpx}\left(\mathit{i},\mathit{j}\right)$ contains the value of $\frac{\partial U_{\mathit{i}}\left(x,t\right)}{\partial x}$ at the coupling point $x={\xi }_{\mathit{j}}$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nxi}$.

10:   $\mathbf{rcp}\left(\mathbf{npde},\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{rcp}\left(\mathit{i},\mathit{j}\right)$ contains the value of the flux $R_{\mathit{i}}$ at the coupling point $x={\xi }_{\mathit{j}}$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nxi}$.

11:   $\mathbf{ucpt}\left(\mathbf{npde},\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: if $\mathbf{nxi}>0$, $\mathbf{ucpt}\left(\mathit{i},\mathit{j}\right)$ contains the value of $\frac{\partial U_{\mathit{i}}}{\partial t}$ at the coupling point $x={\xi }_{\mathit{j}}$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nxi}$.

12:   $\mathbf{ucptx}\left(\mathbf{npde},\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{ucptx}\left(\mathit{i},\mathit{j}\right)$ contains the value of $\frac{{\partial }^2{U}_{\mathit{i}}}{\partial x\partial t}$ at the coupling point $x={\xi }_{\mathit{j}}$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{nxi}$.

13:   $\mathbf{f}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{f}\left(\mathit{i}\right)$ must contain the $\mathit{i}$th component of $F$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$, where $F$ is defined as

$$F=G-A\stackrel{.}{V}-B\left(\begin{array}{c}{U}_t^{*}\\ U_{xt}^{*}\end{array}\right)\text{,}$$

(5)

or

$$F=-A\stackrel{.}{V}-B\left(\begin{array}{c}{U}_t^{*}\\ U_{xt}^{*}\end{array}\right)\text{.}$$

(6)

The definition of $F$ is determined by the input value of ires.

14:   $\mathbf{ires}$ – IntegerInput/Output

On entry: the form of $F$ that must be returned in the array f.

$\mathbf{ires}=1$

Equation (5) must be used.

$\mathbf{ires}=-1$

Equation (6) must be used.

On exit: should usually remain unchanged. However, you may reset ires to force the integration routine to take certain actions as described below:

$\mathbf{ires}=2$

Indicates to the integrator that control should be passed back immediately to the calling (sub)routine 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$, d03pjf/d03pja returns to the calling subroutine with the error indicator set to $\mathbf{ifail}=\mathbf{4}$.

Note: the following are additional arguments for specific use with d03pja. Users of d03pjf therefore need not read the remainder of this description.

15:   $\mathbf{iuser}\left(*\right)$ – Integer arrayUser Workspace

16:   $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) arrayUser Workspace

odedef is called with the arguments iuser and ruser as supplied to d03pjf/d03pja. You should use the arrays iuser and ruser to supply information to odedef.

odedef must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d03pjf/d03pja is called. Arguments denoted as Input must not be changed by this procedure.

Note: odedef should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pjf/d03pja. If your code inadvertently does return any NaNs or infinities, d03pjf/d03pja is likely to produce unexpected results.

15:   $\mathbf{nxi}$ – IntegerInput

On entry: the number of ODE/PDE coupling points.

Constraints:

• if $\mathbf{nv}=0$, $\mathbf{nxi}=0$;
• if $\mathbf{nv}>0$, $\mathbf{nxi}\ge 0$.

16:   $\mathbf{xi}\left(\mathbf{nxi}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{xi}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nxi}$, must be set to the ODE/PDE coupling points.

Constraint: $\mathbf{xbkpts}\left(1\right)\le \mathbf{xi}\left(1\right)<\mathbf{xi}\left(2\right)<\cdots <\mathbf{xi}\left(\mathbf{nxi}\right)\le \mathbf{xbkpts}\left(\mathbf{nbkpts}\right)$.

17:   $\mathbf{neqn}$ – IntegerInput

On entry: the number of ODEs in the time direction.

Constraint: $\mathbf{neqn}=\mathbf{npde}\times \mathbf{npts}+\mathbf{nv}$.

18:   $\mathbf{uvinit}$ – Subroutine, supplied by the user.External Procedure

uvinit must compute the initial values of the PDE and the ODE components $U_{\mathit{i}}\left(x_{\mathit{j}},t_0\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{npts}$, and $V_{\mathit{k}}\left(t_0\right)$, for $\mathit{k}=1,2,\dots ,\mathbf{nv}$.

The specification of uvinit for d03pjf is:

Fortran Interface

Subroutine uvinit ( npde, npts, x, u, nv, v) Integer, Intent (In) :: npde, npts, nv Real (Kind=nag_wp), Intent (In) :: x(npts) Real (Kind=nag_wp), Intent (Out) :: u(npde,npts), v(nv)

C Header Interface

#include <nagmk26.h> void  uvinit (const Integer *npde, const Integer *npts, const double x[], double u[], const Integer *nv, double v[])

The specification of uvinit for d03pja is:

Fortran Interface

Subroutine uvinit ( npde, npts, x, u, nv, v, iuser, ruser) Integer, Intent (In) :: npde, npts, nv Integer, Intent (Inout) :: iuser(*) Real (Kind=nag_wp), Intent (In) :: x(npts) Real (Kind=nag_wp), Intent (Inout) :: ruser(*) Real (Kind=nag_wp), Intent (Out) :: u(npde,npts), v(nv)

C Header Interface

#include <nagmk26.h> void  uvinit (const Integer *npde, const Integer *npts, const double x[], double u[], const Integer *nv, double v[], Integer iuser[], double ruser[])

1:     $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:     $\mathbf{npts}$ – IntegerInput

On entry: the number of mesh points in the interval $\left[a,b\right]$.

3:     $\mathbf{x}\left(\mathbf{npts}\right)$ – Real (Kind=nag_wp) arrayInput

On entry: $\mathbf{x}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npts}$, contains the current values of the space variable $x_{\mathit{i}}$.

4:     $\mathbf{u}\left(\mathbf{npde},\mathbf{npts}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{u}\left(\mathit{i},\mathit{j}\right)$ contains the value of the component $U_{\mathit{i}}\left(x_{\mathit{j}},t_0\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$ and $\mathit{j}=1,2,\dots ,\mathbf{npts}$.

5:     $\mathbf{nv}$ – IntegerInput

On entry: the number of coupled ODEs in the system.

6:     $\mathbf{v}\left(\mathbf{nv}\right)$ – Real (Kind=nag_wp) arrayOutput

On exit: $\mathbf{v}\left(\mathit{i}\right)$ contains the value of component $V_{\mathit{i}}\left(t_0\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{nv}$.

Note: the following are additional arguments for specific use with d03pja. Users of d03pjf therefore need not read the remainder of this description.

7:     $\mathbf{iuser}\left(*\right)$ – Integer arrayUser Workspace

8:     $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) arrayUser Workspace

uvinit is called with the arguments iuser and ruser as supplied to d03pjf/d03pja. You should use the arrays iuser and ruser to supply information to uvinit.

uvinit must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which d03pjf/d03pja is called. Arguments denoted as Input must not be changed by this procedure.

Note: uvinit should not return floating-point NaN (Not a Number) or infinity values, since these are not handled by d03pjf/d03pja. If your code inadvertently does return any NaNs or infinities, d03pjf/d03pja is likely to produce unexpected results.

19:   $\mathbf{rtol}\left(*\right)$ – Real (Kind=nag_wp) arrayInput

Note: the dimension of the array rtol must be at least $1$ if $\mathbf{itol}=1$ or $2$ and at least $\mathbf{neqn}$ if $\mathbf{itol}=3$ or $4$.

On entry: the relative local error tolerance.

Constraint: $\mathbf{rtol}\left(i\right)\ge 0.0$ for all relevant $i$.

20:   $\mathbf{atol}\left(*\right)$ – Real (Kind=nag_wp) arrayInput

Note: the dimension of the array atol must be at least $1$ if $\mathbf{itol}=1$ or $3$ and at least $\mathbf{neqn}$ if $\mathbf{itol}=2$ or $4$.

On entry: the absolute local error tolerance.

Constraint: $\mathbf{atol}\left(i\right)\ge 0.0$ for all relevant $i$.

Note: corresponding elements of rtol and atol cannot both be $0.0$.

21:   $\mathbf{itol}$ – IntegerInput

On entry: a value to indicate the form of the local error test. itol indicates to d03pjf/d03pja whether to interpret either or both of rtol or atol as a vector or scalar. The error test to be satisfied is $‖e_i/w_i‖<1.0$, where $w_i$ is defined as follows:

itol	rtol	atol	$w_i$
1	scalar	scalar	$\mathbf{rtol}\left(1\right)\times \left|U_i\right|+\mathbf{atol}\left(1\right)$
2	scalar	vector	$\mathbf{rtol}\left(1\right)\times \left|U_i\right|+\mathbf{atol}\left(i\right)$
3	vector	scalar	$\mathbf{rtol}\left(i\right)\times \left|U_i\right|+\mathbf{atol}\left(1\right)$
4	vector	vector	$\mathbf{rtol}\left(i\right)\times \left|U_i\right|+\mathbf{atol}\left(i\right)$

In the above, $e_{\mathit{i}}$ denotes the estimated local error for the $\mathit{i}$th component of the coupled PDE/ODE system in time, $\mathbf{u}\left(\mathit{i}\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{neqn}$.

The choice of norm used is defined by the argument norm.

Constraint: $1\le \mathbf{itol}\le 4$.

22:   $\mathbf{norm}$ – Character(1)Input

On entry: the type of norm to be used.

$\mathbf{norm}=\text{'M'}$

Maximum norm.

$\mathbf{norm}=\text{'A'}$

Averaged $L_2$ norm.

If ${\mathbf{u}}_{\mathrm{norm}}$ denotes the norm of the vector u of length neqn, then for the averaged $L_2$ norm

$${\mathbf{u}}_{\mathrm{norm}}=\sqrt{\frac{1}{\mathbf{neqn}}\sum _{i=1}^{\mathbf{neqn}}{\left(\mathbf{u}\left(i\right)/w_i\right)}^2}\text{,}$$

while for the maximum norm

$${\mathbf{u}}_{\mathrm{norm}}=\underset{i}{\max }\left|\mathbf{u}\left(i\right)/w_i\right|\text{.}$$

See the description of itol for the formulation of the weight vector $w$.

Constraint: $\mathbf{norm}=\text{'M'}$ or $\text{'A'}$.

23:   $\mathbf{laopt}$ – Character(1)Input

On entry: the type of matrix algebra required.

$\mathbf{laopt}=\text{'F'}$

Full matrix methods to be used.

$\mathbf{laopt}=\text{'B'}$

Banded matrix methods to be used.

$\mathbf{laopt}=\text{'S'}$

Sparse matrix methods to be used.

Constraint: $\mathbf{laopt}=\text{'F'}$, $\text{'B'}$ or $\text{'S'}$.

Note: you are recommended to use the banded option when no coupled ODEs are present (i.e., $\mathbf{nv}=0$).

24:   $\mathbf{algopt}\left(30\right)$ – Real (Kind=nag_wp) arrayInput

On entry: may be set to control various options available in the integrator. If you wish to employ all the default options, $\mathbf{algopt}\left(1\right)$ should be set to $0.0$. Default values will also be used for any other elements of algopt set to zero. The permissible values, default values, and meanings are as follows:

$\mathbf{algopt}\left(1\right)$

Selects the ODE integration method to be used. If $\mathbf{algopt}\left(1\right)=1.0$, a BDF method is used and if $\mathbf{algopt}\left(1\right)=2.0$, a Theta method is used. The default value is $\mathbf{algopt}\left(1\right)=1.0$.

If $\mathbf{algopt}\left(1\right)=2.0$, $\mathbf{algopt}\left(\mathit{i}\right)$, for $\mathit{i}=2,3,4$ are not used.

$\mathbf{algopt}\left(2\right)$

Specifies the maximum order of the BDF integration formula to be used. $\mathbf{algopt}\left(2\right)$ may be $1.0$, $2.0$, $3.0$, $4.0$ or $5.0$. The default value is $\mathbf{algopt}\left(2\right)=5.0$.

$\mathbf{algopt}\left(3\right)$

Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the BDF method. If $\mathbf{algopt}\left(3\right)=1.0$ a modified Newton iteration is used and if $\mathbf{algopt}\left(3\right)=2.0$ a functional iteration method is used. If functional iteration is selected and the integrator encounters difficulty, there is an automatic switch to the modified Newton iteration. The default value is $\mathbf{algopt}\left(3\right)=1.0$.

$\mathbf{algopt}\left(4\right)$

Specifies whether or not the Petzold error test is to be employed. The Petzold error test results in extra overhead but is more suitable when algebraic equations are present, such as $P_{i,\mathit{j}}=0.0$, for $\mathit{j}=1,2,\dots ,\mathbf{npde}$, for some $i$ or when there is no ${\stackrel{.}{V}}_i\left(t\right)$ dependence in the coupled ODE system. If $\mathbf{algopt}\left(4\right)=1.0$, the Petzold test is used. If $\mathbf{algopt}\left(4\right)=2.0$, the Petzold test is not used. The default value is $\mathbf{algopt}\left(4\right)=1.0$.

If $\mathbf{algopt}\left(1\right)=1.0$, $\mathbf{algopt}\left(\mathit{i}\right)$, for $\mathit{i}=5,6,7$, are not used.

$\mathbf{algopt}\left(5\right)$

Specifies the value of Theta to be used in the Theta integration method. $0.51\le \mathbf{algopt}\left(5\right)\le 0.99$. The default value is $\mathbf{algopt}\left(5\right)=0.55$.

$\mathbf{algopt}\left(6\right)$

Specifies what method is to be used to solve the system of nonlinear equations arising on each step of the Theta method. If $\mathbf{algopt}\left(6\right)=1.0$, a modified Newton iteration is used and if $\mathbf{algopt}\left(6\right)=2.0$, a functional iteration method is used. The default value is $\mathbf{algopt}\left(6\right)=1.0$.

$\mathbf{algopt}\left(7\right)$

Specifies whether or not the integrator is allowed to switch automatically between modified Newton and functional iteration methods in order to be more efficient. If $\mathbf{algopt}\left(7\right)=1.0$, switching is allowed and if $\mathbf{algopt}\left(7\right)=2.0$, switching is not allowed. The default value is $\mathbf{algopt}\left(7\right)=1.0$.

$\mathbf{algopt}\left(11\right)$

Specifies a point in the time direction, $t_{\mathrm{crit}}$, beyond which integration must not be attempted. The use of $t_{\mathrm{crit}}$ is described under the argument itask. If $\mathbf{algopt}\left(1\right)\ne 0.0$, a value of $0.0$ for $\mathbf{algopt}\left(11\right)$, say, should be specified even if itask subsequently specifies that $t_{\mathrm{crit}}$ will not be used.

$\mathbf{algopt}\left(12\right)$

Specifies the minimum absolute step size to be allowed in the time integration. If this option is not required, $\mathbf{algopt}\left(12\right)$ should be set to $0.0$.

$\mathbf{algopt}\left(13\right)$

Specifies the maximum absolute step size to be allowed in the time integration. If this option is not required, $\mathbf{algopt}\left(13\right)$ should be set to $0.0$.

$\mathbf{algopt}\left(14\right)$

Specifies the initial step size to be attempted by the integrator. If $\mathbf{algopt}\left(14\right)=0.0$, the initial step size is calculated internally.

$\mathbf{algopt}\left(15\right)$

Specifies the maximum number of steps to be attempted by the integrator in any one call. If $\mathbf{algopt}\left(15\right)=0.0$, no limit is imposed.

$\mathbf{algopt}\left(23\right)$

Specifies what method is to be used to solve the nonlinear equations at the initial point to initialize the values of $U$, $U_t$, $V$ and $\stackrel{.}{V}$. If $\mathbf{algopt}\left(23\right)=1.0$, a modified Newton iteration is used and if $\mathbf{algopt}\left(23\right)=2.0$, functional iteration is used. The default value is $\mathbf{algopt}\left(23\right)=1.0$.

$\mathbf{algopt}\left(29\right)$ and $\mathbf{algopt}\left(30\right)$ are used only for the sparse matrix algebra option, $\mathbf{laopt}=\text{'S'}$.

$\mathbf{algopt}\left(29\right)$

Governs the choice of pivots during the decomposition of the first Jacobian matrix. It should lie in the range $0.0<\mathbf{algopt}\left(29\right)<1.0$, with smaller values biasing the algorithm towards maintaining sparsity at the expense of numerical stability. If $\mathbf{algopt}\left(29\right)$ lies outside this range then the default value is used. If the routines regard the Jacobian matrix as numerically singular then increasing $\mathbf{algopt}\left(29\right)$ towards $1.0$ may help, but at the cost of increased fill-in. The default value is $\mathbf{algopt}\left(29\right)=0.1$.

$\mathbf{algopt}\left(30\right)$

Is used as a relative pivot threshold during subsequent Jacobian decompositions (see $\mathbf{algopt}\left(29\right)$) below which an internal error is invoked. If $\mathbf{algopt}\left(30\right)$ is greater than $1.0$ no check is made on the pivot size, and this may be a necessary option if the Jacobian is found to be numerically singular (see $\mathbf{algopt}\left(29\right)$). The default value is $\mathbf{algopt}\left(30\right)=0.0001$.

25:   $\mathbf{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.

26:   $\mathbf{lrsave}$ – IntegerInput

On entry: the dimension of the array rsave as declared in the (sub)program from which d03pjf/d03pja is called. Its size depends on the type of matrix algebra selected.

If $\mathbf{laopt}=\text{'F'}$, $\mathbf{lrsave}\ge \mathbf{neqn}\times \mathbf{neqn}+\mathbf{neqn}+\mathit{nwkres}+\mathit{lenode}$.

If $\mathbf{laopt}=\text{'B'}$, $\mathbf{lrsave}\ge \left(3\times \mathit{mlu}+1\right)\times \mathbf{neqn}+\mathit{nwkres}+\mathit{lenode}$.

If $\mathbf{laopt}=\text{'S'}$, $\mathbf{lrsave}\ge 4\times \mathbf{neqn}+11\times \mathbf{neqn}/2+1+\mathit{nwkres}+\mathit{lenode}$.

Where

	$\mathit{mlu}$ is the lower or upper half bandwidths such that $\mathit{mlu}=3\times \mathbf{npde}-1$, for PDE problems only (no coupled ODEs); or $\mathit{mlu}=\mathbf{neqn}-1$, for coupled PDE/ODE problems.
	$\mathit{nwkres}=\left\{\begin{array}{ll}3\times {\left(\mathbf{npoly}+1\right)}^2+\left(\mathbf{npoly}+1\right)\times \left[{\mathbf{npde}}^2+6\times \mathbf{npde}+\mathbf{nbkpts}+1\right]+8\times \mathbf{npde}+\mathbf{nxi}\times \left(5\times \mathbf{npde}+1\right)+\mathbf{nv}+3\text{,}& \text{when }\mathbf{nv}>0\text{ and }\mathbf{nxi}>0\text{; or}\\ 3\times {\left(\mathbf{npoly}+1\right)}^2+\left(\mathbf{npoly}+1\right)\times \left[{\mathbf{npde}}^2+6\times \mathbf{npde}+\mathbf{nbkpts}+1\right]+13\times \mathbf{npde}+\mathbf{nv}+4\text{,}& \text{when }\mathbf{nv}>0\text{ and }\mathbf{nxi}=0\text{; or}\\ 3\times {\left(\mathbf{npoly}+1\right)}^2+\left(\mathbf{npoly}+1\right)\times \left[{\mathbf{npde}}^2+6\times \mathbf{npde}+\mathbf{nbkpts}+1\right]+13\times \mathbf{npde}+5\text{,}& \text{when }\mathbf{nv}=0\text{.}\end{array}\right.$
	$\mathit{lenode}=\left\{\begin{array}{ll}\left(6+\mathrm{int}\left(\mathbf{algopt}\left(2\right)\right)\right)\times \mathbf{neqn}+50\text{,}& \text{when the BDF method is used; or}\\ 9\times \mathbf{neqn}+50\text{,}& \text{when the Theta method is used.}\end{array}\right.$

Note: when $\mathbf{laopt}=\text{'S'}$, the value of lrsave may be too small when supplied to the integrator. An estimate of the minimum size of lrsave is printed on the current error message unit if $\mathbf{itrace}>0$ and the routine returns with $\mathbf{ifail}=\mathbf{15}$.

27:   $\mathbf{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 required for subsequent calls. 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 ODE method last used in the time integration.

$\mathbf{isave}\left(5\right)$

Contains the number of Newton iterations performed by the time integrator. Each iteration involves residual evaluation of the resulting ODE system followed by a back-substitution using the $LU$ decomposition of the Jacobian matrix.

28:   $\mathbf{lisave}$ – IntegerInput

On entry: the dimension of the array isave as declared in the (sub)program from which d03pjf/d03pja is called. Its size depends on the type of matrix algebra selected:

• if $\mathbf{laopt}=\text{'F'}$, $\mathbf{lisave}\ge 24$;
• if $\mathbf{laopt}=\text{'B'}$, $\mathbf{lisave}\ge \mathbf{neqn}+24$;
• if $\mathbf{laopt}=\text{'S'}$, $\mathbf{lisave}\ge 25\times \mathbf{neqn}+24$.

Note: when using the sparse option, the value of lisave may be too small when supplied to the integrator. An estimate of the minimum size of lisave is printed on the current error message unit if $\mathbf{itrace}>0$ and the routine returns with $\mathbf{ifail}=\mathbf{15}$.

29:   $\mathbf{itask}$ – IntegerInput

On entry: specifies the task to be performed by the ODE integrator.

$\mathbf{itask}=1$

Normal computation of output values u at $t=\mathbf{tout}$.

$\mathbf{itask}=2$

One step and return.

$\mathbf{itask}=3$

Stop at first internal integration point at or beyond $t=\mathbf{tout}$.

$\mathbf{itask}=4$

Normal computation of output values u at $t=\mathbf{tout}$ but without overshooting $t=t_{\mathrm{crit}}$ where $t_{\mathrm{crit}}$ is described under the argument algopt.

$\mathbf{itask}=5$

Take one step in the time direction and return, without passing $t_{\mathrm{crit}}$, where $t_{\mathrm{crit}}$ is described under the argument algopt.

Constraint: $\mathbf{itask}=1$, $2$, $3$, $4$ or $5$.

30:   $\mathbf{itrace}$ – IntegerInput

On entry: the level of trace information required from d03pjf/d03pja 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$, $-1$ is assumed and similarly if $\mathbf{itrace}>3$, $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 Sub-chapter D02M–N.

31:   $\mathbf{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 arguments tout and ifail should be reset between calls to d03pjf/d03pja.

Constraint: $\mathbf{ind}=0$ or $1$.

On exit: $\mathbf{ind}=1$.

32:   $\mathbf{ifail}$ – IntegerInput/Output

Note: for d03pja, ifail does not occur in this position in the argument list. See the additional arguments described below.

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation 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 argument, 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).

Note: the following are additional arguments for specific use with d03pja. Users of d03pjf therefore need not read the remainder of this description.

32:   $\mathbf{iuser}\left(*\right)$ – Integer arrayUser Workspace

33:   $\mathbf{ruser}\left(*\right)$ – Real (Kind=nag_wp) arrayUser Workspace

iuser and ruser are not used by d03pjf/d03pja, but are passed directly to pdedef, bndary, odedef and uvinit and may be used to pass information to these routines.

34:   $\mathbf{cwsav}\left(10\right)$ – Character(80) arrayCommunication Array

35:   $\mathbf{lwsav}\left(100\right)$ – Logical arrayCommunication Array

36:   $\mathbf{iwsav}\left(505\right)$ – Integer arrayCommunication Array

37:   $\mathbf{rwsav}\left(1100\right)$ – Real (Kind=nag_wp) arrayCommunication Array

38:   $\mathbf{ifail}$ – IntegerInput/Output

Note: see the argument description for ifail above.

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

On entry, $\mathbf{algopt}\left(1\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{algopt}\left(1\right)=0.0$, $1.0$ or $2.0$.

On entry, at least one point in xi lies outside $\left[\mathbf{xbkpts}\left(1\right),\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)\right]$: $\mathbf{xbkpts}\left(1\right)=〈\mathit{\text{value}}〉$ and $\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)=〈\mathit{\text{value}}〉$.

On entry, $\mathit{i}=〈\mathit{\text{value}}〉$, $\mathbf{xbkpts}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$, $\mathit{j}=〈\mathit{\text{value}}〉$ and $\mathbf{xbkpts}\left(\mathit{j}\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{xbkpts}\left(1\right)<\mathbf{xbkpts}\left(2\right)<\cdots <\mathbf{xbkpts}\left(\mathbf{nbkpts}\right)$.

On entry, $\mathit{i}=〈\mathit{\text{value}}〉$, $\mathbf{xi}\left(\mathit{i}+1\right)=〈\mathit{\text{value}}〉$ and $\mathbf{xi}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{xi}\left(\mathit{i}+1\right)>\mathbf{xi}\left(\mathit{i}\right)$.

On entry, $\mathit{i}=〈\mathit{\text{value}}〉$ and $\mathbf{atol}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{atol}\left(\mathit{i}\right)\ge 0.0$.

On entry, $\mathit{i}=〈\mathit{\text{value}}〉$ and $\mathit{j}=〈\mathit{\text{value}}〉$.
Constraint: corresponding elements $\mathbf{atol}\left(\mathit{i}\right)$ and $\mathbf{rtol}\left(\mathit{j}\right)$ cannot both be $0.0$.

On entry, $\mathit{i}=〈\mathit{\text{value}}〉$ and $\mathbf{rtol}\left(\mathit{i}\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{rtol}\left(\mathit{i}\right)\ge 0.0$.

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$, $3$, $4$ or $5$.

On entry, $\mathbf{itol}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{itol}=1$, $2$, $3$ or $4$.

On entry, $\mathbf{laopt}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{laopt}=\text{'F'}$, $\text{'B'}$ or $\text{'S'}$.

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}}〉$.

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}=0$, $1$ or $2$.

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$ and $\mathbf{xbkpts}\left(1\right)=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}\le 0$ or $\mathbf{xbkpts}\left(1\right)\ge 0.0$ 

On entry, $\mathbf{nbkpts}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nbkpts}\ge 2$.

On entry, $\mathbf{neqn}=〈\mathit{\text{value}}〉$, $\mathbf{npde}=〈\mathit{\text{value}}〉$, $\mathbf{npts}=〈\mathit{\text{value}}〉$ and $\mathbf{nv}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{neqn}=\mathbf{npde}\times \mathbf{npts}+\mathbf{nv}$.

On entry, $\mathbf{norm}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{norm}=\text{'A'}$ or $\text{'M'}$.

On entry, $\mathbf{npde}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{npde}\ge 1$.

On entry, $\mathbf{npoly}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{npoly}\le 49$.

On entry, $\mathbf{npoly}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{npoly}\ge 1$.

On entry, $\mathbf{npts}=〈\mathit{\text{value}}〉$, $\mathbf{nbkpts}=〈\mathit{\text{value}}〉$ and $\mathbf{npoly}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{npts}=\left(\mathbf{nbkpts}-1\right)\times \mathbf{npoly}+1$.

On entry, $\mathbf{nv}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nv}\ge 0$.

On entry, $\mathbf{nv}=〈\mathit{\text{value}}〉$ and $\mathbf{nxi}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nxi}=0$ when $\mathbf{nv}=0$.

On entry, $\mathbf{nv}=〈\mathit{\text{value}}〉$ and $\mathbf{nxi}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nxi}\ge 0$ when $\mathbf{nv}>0$.

On entry, on initial entry $\mathbf{ind}=1$.
Constraint: on initial entry $\mathbf{ind}=0$.

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}}〉$.

$\mathbf{ifail}=2$

Underlying ODE solver cannot make further progress from the point ts with the supplied values of atol and rtol. $\mathbf{ts}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=3$

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.

$\mathbf{ifail}=4$

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 or bndary.

$\mathbf{ifail}=5$

Singular Jacobian of ODE system. Check problem formulation.

$\mathbf{ifail}=6$

In evaluating residual of ODE system, $\mathbf{ires}=2$ has been set in pdedef, bndary, or odedef. Integration is successful as far as ts: $\mathbf{ts}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=7$

atol and rtol were too small to start integration.

$\mathbf{ifail}=8$

ires set to an invalid value in call to pdedef, bndary, or odedef.

$\mathbf{ifail}=9$

Serious error in internal call to an auxiliary. Increase itrace for further details.

$\mathbf{ifail}=10$

Integration completed, but small changes in atol or rtol are unlikely to result in a changed solution.

The required task has been completed, but it is estimated that a small change in atol and rtol is unlikely to produce any change in the computed solution. (Only applies when you are not operating in one step mode, that is when $\mathbf{itask}\ne 2$ or $5$.)

$\mathbf{ifail}=11$

Error during Jacobian formulation for ODE system. Increase itrace for further details.

$\mathbf{ifail}=12$

In solving ODE system, the maximum number of steps $\mathbf{algopt}\left(15\right)$ has been exceeded. $\mathbf{algopt}\left(15\right)=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=13$

Zero error weights encountered during time integration.

Some error weights $w_i$ became zero during the time integration (see the description of itol). Pure relative error control ($\mathbf{atol}\left(i\right)=0.0$) was requested on a variable (the $i$th) which has become zero. The integration was successful as far as $t=\mathbf{ts}$.

$\mathbf{ifail}=14$

Flux function appears to depend on time derivatives.

$\mathbf{ifail}=15$

When using the sparse option lisave or lrsave is too small: $\mathbf{lisave}=〈\mathit{\text{value}}〉$, $\mathbf{lrsave}=〈\mathit{\text{value}}〉$.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (d03pjfe.f90)

Program Text (d03pjae.f90)

10.2

Program Data

Program Data (d03pjfe.d)

Program Data (d03pjae.d)

10.3

Program Results

Program Results (d03pjfe.r)

Program Results (d03pjae.r)