NAG C Library Function Document

nag_pde_parab_1d_fd (d03pcc)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:    $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system 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}$ – 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}$.

4:    $\mathbf{tout}$ – doubleInput

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

5:    $\mathbf{pdedef}$ – function, supplied by the userExternal Function

pdedef must compute the functions $P_{i,j}$, $Q_i$ and $R_i$ which define the system of PDEs. pdedef is called approximately midway between each pair of mesh points in turn by nag_pde_parab_1d_fd (d03pcc).

The specification of pdedef is:

void  pdedef (Integer npde, double t, double x, const double u[], const double ux[], double p[], double q[], double r[], Integer *ires, Nag_Comm *comm)

1:    $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:    $\mathbf{t}$ – doubleInput

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

3:    $\mathbf{x}$ – doubleInput

On entry: the current value of the space variable $x$.

4:    $\mathbf{u}\left[\mathbf{npde}\right]$ – const doubleInput

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 doubleInput

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}\times \mathbf{npde}\right]$ – doubleOutput

Note: the $\left(i,j\right)$th element of the matrix $P$ is stored in $\mathbf{p}\left[\left(j-1\right)\times \mathbf{npde}+i-1\right]$.

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

7:    $\mathbf{q}\left[\mathbf{npde}\right]$ – doubleOutput

On exit: $\mathbf{q}\left[\mathit{i}-1\right]$ must be set to the value of $Q_{\mathit{i}}\left(x,t,U,U_x\right)$, for $\mathit{i}=1,2,\dots ,\mathbf{npde}$.

8:    $\mathbf{r}\left[\mathbf{npde}\right]$ – doubleOutput

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

9:    $\mathbf{ires}$ – Integer *Input/Output

On entry: set to $-1\text{ 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$, nag_pde_parab_1d_fd (d03pcc) returns to the calling function with the error indicator set to $\mathbf{fail}\mathbf{.}\mathbf{code}=$ NE_FAILED_DERIV.

10:  $\mathbf{comm}$ – Nag_Comm *

Pointer to structure of type Nag_Comm; the following members are relevant to pdedef.

user – double *

iuser – Integer *

p – Pointer 

The type Pointer will be void *. Before calling nag_pde_parab_1d_fd (d03pcc) you may allocate memory and initialize these pointers with various quantities for use by pdedef when called from nag_pde_parab_1d_fd (d03pcc) (see Section 3.3.1.1 in How to Use the NAG Library and its Documentation).

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

6:    $\mathbf{bndary}$ – function, supplied by the userExternal Function

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

The specification of bndary is:

void  bndary (Integer npde, double t, const double u[], const double ux[], Integer ibnd, double beta[], double gamma[], Integer *ires, Nag_Comm *comm)

1:    $\mathbf{npde}$ – IntegerInput

On entry: the number of PDEs in the system.

2:    $\mathbf{t}$ – doubleInput

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

3:    $\mathbf{u}\left[\mathbf{npde}\right]$ – const doubleInput

On entry: $\mathbf{u}\left[\mathit{i}-1\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]$ – const doubleInput

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

5:    $\mathbf{ibnd}$ – IntegerInput

On entry: determines the position of the boundary conditions.

$\mathbf{ibnd}=0$

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

$\mathbf{ibnd}\ne 0$

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

6:    $\mathbf{beta}\left[\mathbf{npde}\right]$ – doubleOutput

On exit: $\mathbf{beta}\left[\mathit{i}-1\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}$.

7:    $\mathbf{gamma}\left[\mathbf{npde}\right]$ – doubleOutput

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

8:    $\mathbf{ires}$ – Integer *Input/Output

On entry: set to $-1\text{ 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$, nag_pde_parab_1d_fd (d03pcc) 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.

user – double *

iuser – Integer *

p – Pointer 

The type Pointer will be void *. Before calling nag_pde_parab_1d_fd (d03pcc) you may allocate memory and initialize these pointers with various quantities for use by bndary when called from nag_pde_parab_1d_fd (d03pcc) (see Section 3.3.1.1 in How to Use the NAG Library and its Documentation).

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

7:    $\mathbf{u}\left[\mathbf{npde}\times \mathbf{npts}\right]$ – doubleInput/Output

Note: the $\left(i,j\right)$th element of the matrix $U$ is stored in $\mathbf{u}\left[\left(j-1\right)\times \mathbf{npde}+i-1\right]$.

On entry: the initial values of $U\left(x,t\right)$ at $t=\mathbf{ts}$ and the mesh points $\mathbf{x}\left[\mathit{j}-1\right]$, for $\mathit{j}=1,2,\dots ,\mathbf{npts}$.

On exit: $\mathbf{u}\left[\left(\mathit{j}-1\right)\times \mathbf{npde}+\mathit{i}-1\right]$ will contain the computed solution at $t=\mathbf{ts}$.

8:    $\mathbf{npts}$ – IntegerInput

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 doubleInput

On entry: the mesh points in the spatial 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}$ – doubleInput

On entry: a positive quantity for controlling the local error estimate in the time integration. If $E\left(i,j\right)$ is the estimated error for $U_i$ at the $j$th mesh point, the error test is:

$$\left|E\left(i,j\right)\right|=\mathbf{acc}\times \left(1.0+\left|\mathbf{u}\left[\left(j-1\right)\times \mathbf{npde}+i-1\right]\right|\right)\text{.}$$

Constraint: $\mathbf{acc}>0.0$.

11:  $\mathbf{rsave}\left[\mathbf{lrsave}\right]$ – doubleCommunication 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.

12:  $\mathbf{lrsave}$ – IntegerInput

On entry: the dimension of the array rsave.

Constraint: $\mathbf{lrsave}\ge \left(6\times \mathbf{npde}+10\right)\times \mathbf{npde}\times \mathbf{npts}+\left(3\times \mathbf{npde}+21\right)\times \mathbf{npde}+7\times \mathbf{npts}+54$.

13:  $\mathbf{isave}\left[\mathbf{lisave}\right]$ – IntegerCommunication 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.

14:  $\mathbf{lisave}$ – IntegerInput

On entry: the dimension of the array isave.

Constraint: $\mathbf{lisave}\ge \mathbf{npde}\times \mathbf{npts}+24$.

15:  $\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}$.

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

16:  $\mathbf{itrace}$ – IntegerInput

On entry: the level of trace information required from nag_pde_parab_1d_fd (d03pcc) 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.

17:  $\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.

18:  $\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 arguments tout and fail should be reset between calls to nag_pde_parab_1d_fd (d03pcc).

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

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

19:  $\mathbf{comm}$ – Nag_Comm *

The NAG communication argument (see Section 3.3.1.1 in How to Use the NAG Library and its Documentation).

20:  $\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.

21:  $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6

Error Indicators and Warnings

NE_ACC_IN_DOUBT

Integration completed, but a small change in acc is unlikely to result in a changed solution. $\mathbf{acc}=〈\mathit{\text{value}}〉$.

NE_ALLOC_FAIL

Dynamic memory allocation failed.
See Section 2.3.1.2 in How to Use the NAG Library and its Documentation for further information.

NE_BAD_PARAM

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

NE_FAILED_START

acc was too small to start integration: $\mathbf{acc}=〈\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}}〉$.

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

NE_INCOMPAT_PARAM

On entry, $\mathbf{m}=〈\mathit{\text{value}}〉$ and $\mathbf{x}\left[0\right]=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}\le 0$ or $\mathbf{x}\left[0\right]\ge 0.0$ 

NE_INT

ires set to an invalid value in call to pdedef 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{m}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{m}=0$, $1$ or $2$.

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 2.7.6 in How to Use the NAG Library and its Documentation 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 2.7.5 in How to Use the NAG Library and its Documentation 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}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{acc}>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

Flux function appears to depend on time derivatives.

NE_USER_STOP

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

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (d03pcce.c)

10.2

Program Data

10.3

Program Results

Program Results (d03pcce.r)