NAG Library Routine Document

D02PSF

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

1:   N – INTEGERInput

On entry: $n$, the number of ordinary differential equations in the system to be solved by the integration routine.

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

2:   TWANT – REAL (KIND=nag_wp)Input

On entry: $t$, the value of the independent variable where a solution is desired.

3:   IDERIV – INTEGERInput

On entry: determines whether the solution and/or its first derivative are to be computed

$\mathbf{IDERIV}=0$

compute approximate solution.

$\mathbf{IDERIV}=1$

compute approximate first derivative.

$\mathbf{IDERIV}=2$

compute approximate solution and first derivative.

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

4:   NWANT – INTEGERInput

On entry: the number of components of the solution to be computed. The first NWANT components are evaluated.

Constraint: $1\le \mathbf{NWANT}\le \mathbf{N}$.

5:   YWANT(NWANT) – REAL (KIND=nag_wp) arrayOutput

On exit: an approximation to the first NWANT components of the solution at TWANT if $\mathbf{IDERIV}=0$ or $2$. Otherwise YWANT is not defined.

6:   YPWANT(NWANT) – REAL (KIND=nag_wp) arrayOutput

On exit: an approximation to the first NWANT components of the first derivative at TWANT if $\mathbf{IDERIV}=1$ or $2$. Otherwise YPWANT is not defined.

7:   F – SUBROUTINE, supplied by the user.External Procedure

F must evaluate the functions $f_i$ (that is the first derivatives $y_i^{\prime }$) for given values of the arguments $t,y_i$. It must be the same procedure as supplied to D02PFF.

The specification of F is:

SUBROUTINE F ( T, N, Y, YP, IUSER, RUSER)

INTEGER N, IUSER(*)

REAL (KIND=nag_wp) T, Y(N), YP(N), RUSER(*)

1:   T – REAL (KIND=nag_wp)Input

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

2:   N – INTEGERInput

On entry: $\mathit{n}$, the number of ordinary differential equations in the system to be solved.

3:   Y(N) – REAL (KIND=nag_wp) arrayInput

On entry: the current values of the dependent variables, $y_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$.

4:   YP(N) – REAL (KIND=nag_wp) arrayOutput

On exit: the values of $f_{\mathit{i}}$, for $\mathit{i}=1,2,\dots ,\mathit{n}$.

5:   IUSER($*$) – INTEGER arrayUser Workspace

6:   RUSER($*$) – REAL (KIND=nag_wp) arrayUser Workspace

F is called with the parameters IUSER and RUSER as supplied to D02PSF. You are free to use the arrays IUSER and RUSER to supply information to F as an alternative to using COMMON global variables.

F must either be a module subprogram USEd by, or declared as EXTERNAL in, the (sub)program from which D02PSF is called. Parameters denoted as Input must not be changed by this procedure.

8:   WCOMM(LWCOMM) – REAL (KIND=nag_wp) arrayCommunication Array

On entry: this array stores information that can be utilized on subsequent calls to D02PSF.

9:   LWCOMM – INTEGERInput

On entry: length of WCOMM.

$\mathbf{METHOD}=1$ or $-1$

LWCOMM must be at least $1$.

$\mathbf{METHOD}=2$ or $-2$

LWCOMM must be at least $\mathbf{N}+\max \left(\mathbf{N},5\times \mathbf{NWANT}\right)$.

10:   IUSER($*$) – INTEGER arrayUser Workspace

11:   RUSER($*$) – REAL (KIND=nag_wp) arrayUser Workspace

IUSER and RUSER are not used by D02PSF, but are passed directly to F and may be used to pass information to this routine as an alternative to using COMMON global variables.

12:   IWSAV($130$) – INTEGER arrayCommunication Array

13:   RWSAV($32\times \mathbf{N}+350$) – REAL (KIND=nag_wp) arrayCommunication Array

On entry: these must be the same arrays supplied in a previous call D02PFF. They must remain unchanged between calls.

On exit: information about the integration for use on subsequent calls to D02PFF, D02PSF or other associated routines.

14:   IFAIL – INTEGERInput/Output

On entry: IFAIL must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$. When the value $-\mathbf{1}\text{ or }\mathbf{1}$ is used it is essential to test the value of IFAIL on exit.

On exit: $\mathbf{IFAIL}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

$\mathbf{IFAIL}=1$

$\left|\mathbf{METHOD}\right|=3$ in setup, but interpolation is not available for this method. Either use $\left|\mathbf{METHOD}\right|=2$ in setup or use reset routine to force the integrator to step to particular points.

On entry, a previous call to the setup routine has not been made or the communication arrays have become corrupted, or a catastrophic error has already been detected elsewhere.
You cannot continue integrating the problem.

On entry, $\mathbf{IDERIV}=⟨\mathit{\text{value}}⟩$.
Constraint: $\mathbf{IDERIV}=0$, $1$ or $2$.

On entry, $\mathbf{LWCOMM}=⟨\mathit{\text{value}}⟩$, $\mathbf{N}=⟨\mathit{\text{value}}⟩$ and $\mathbf{NWANT}=⟨\mathit{\text{value}}⟩$.
Constraint: for $\left|\mathbf{METHOD}\right|=2$, $\mathbf{LWCOMM}\ge \mathbf{N}+5\mathbf{NWANT}$.

On entry, $\mathbf{LWCOMM}=⟨\mathit{\text{value}}⟩$.
Constraint: For $\left|\mathbf{METHOD}\right|=1$, $\mathbf{LWCOMM}\ge 1$.

On entry, $\mathbf{N}=⟨\mathit{\text{value}}⟩$, but the value passed to the setup routine was $\mathbf{N}=⟨\mathit{\text{value}}⟩$.

On entry, $\mathbf{NWANT}=⟨\mathit{\text{value}}⟩$ and $\mathbf{N}=⟨\mathit{\text{value}}⟩$.
Constraint: $1\le \mathbf{NWANT}\le \mathbf{N}$.

You cannot call this routine after the integrator has returned an error.

You cannot call this routine before you have called the step integrator.

You cannot call this routine when you have specified, in the setup routine, that the range integrator will be used.

7 Accuracy

8 Further Comments

9 Example

9.1 Program Text

Program Text (d02psfe.f90)

9.2 Program Data

Program Data (d02psfe.d)

9.3 Program Results

Program Results (d02psfe.r)