NAG Library Routine Document

d02ntf (ivp_stiff_bandjac_setup)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{neq}$ – IntegerInput

On entry: the number of differential equations.

Constraint: $1\le \mathbf{neq}\le \mathbf{neqmax}$.

2:     $\mathbf{neqmax}$ – IntegerInput

On entry: a bound on the maximum number of differential equations to be solved during the integration.

Constraint: $\mathbf{neqmax}\ge \mathbf{neq}$.

3:     $\mathbf{jceval}$ – Character(1)Input

On entry: specifies the technique to be used to compute the Jacobian as follows:

$\mathbf{jceval}=\text{'N'}$

The Jacobian is to be evaluated numerically by the integrator. If this option is used, the actual argument corresponding to jac in the call to d02ncf or d02nhf must be either d02ncz or d02nhz respectively.

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

You must supply a (sub)program to evaluate the Jacobian on a call to the integrator.

$\mathbf{jceval}=\text{'D'}$

The default choice is to be made. In this case 'D' is interpreted as 'N'.

Only the first character of the actual argument jceval is passed to d02ntf; hence it is permissible for the actual argument to be more descriptive, e.g., ‘Numerical’, ‘Analytical’ or ‘Default’, on a call to d02ntf.

Constraint: $\mathbf{jceval}=\text{'N'}$, $\text{'A'}$ or $\text{'D'}$.

4:     $\mathbf{ml}$ – IntegerInput

On entry: $m_L$, the number of subdiagonals in the band.

Constraint: $0\le \mathbf{ml}\le \mathbf{neq}-1$.

5:     $\mathbf{mu}$ – IntegerInput

On entry: $m_U$, the number of superdiagonals in the band.

Constraint: $0\le \mathbf{mu}\le \mathbf{neq}-1$.

6:     $\mathbf{nwkjac}$ – IntegerInput

On entry: the size of the workspace array wkjac, which you are supplying to the integrator, as declared in the (sub)program from which d02ntf is called.

Constraint: $\mathbf{nwkjac}\ge \left(2\times \mathbf{ml}+\mathbf{mu}+1\right)\times \mathbf{neqmax}$.

7:     $\mathbf{njcpvt}$ – IntegerInput

On entry: the size of the workspace array jacpvt, which you are supplying to the integrator, as declared in the (sub)program from which d02ntf is called.

Constraint: $\mathbf{njcpvt}\ge \mathbf{neqmax}$.

8:     $\mathbf{rwork}\left(50+4\times \mathbf{neqmax}\right)$ – Real (Kind=nag_wp) arrayCommunication Array

This must be the same workspace array as the array rwork supplied to the integrator. It is used to pass information from the setup routine to the integrator and therefore the contents of this array must not be changed before calling the integrator.

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

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).

6

Error Indicators and Warnings

$\mathbf{ifail}=1$

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

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

On entry, $\mathbf{ml}=〈\mathit{\text{value}}〉$ and $\mathbf{neq}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{ml}\le \mathbf{neq}-1$.

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

On entry, $\mathbf{mu}=〈\mathit{\text{value}}〉$ and $\mathbf{neq}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{mu}\le \mathbf{neq}-1$.

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

On entry, $\mathbf{neq}=〈\mathit{\text{value}}〉$ and $\mathbf{neqmax}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{neq}\le \mathbf{neqmax}$.

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

On entry, $\mathbf{njcpvt}=〈\mathit{\text{value}}〉$ and $\mathbf{neqmax}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{njcpvt}\ge \mathbf{neqmax}$.

On entry, $\mathbf{nwkjac}=〈\mathit{\text{value}}〉$, $\mathbf{ml}=〈\mathit{\text{value}}〉$, $\mathbf{mu}=〈\mathit{\text{value}}〉$ and $\mathbf{neqmax}=〈\mathit{\text{value}}〉$.
Constraint: $\mathbf{nwkjac}\ge \left(2\times \mathbf{ml}+\mathbf{mu}+1\right)\times \mathbf{neqmax}$.

$\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