NAG FL Interface
d02nsf (ivp_​stiff_​fulljac_​setup)

Settings help

FL Name Style:

FL Specification Language:

1 Purpose

d02nsf is a setup routine which must be called prior to an integrator in Sub-chapter D02M–N, if full matrix linear algebra is required.

2 Specification

Fortran Interface
Subroutine d02nsf ( neq, neqmax, jceval, nwkjac, rwork, ifail)
Integer, Intent (In) :: neq, neqmax, nwkjac
Integer, Intent (Inout) :: ifail
Real (Kind=nag_wp), Intent (Inout) :: rwork(50+4*neqmax)
Character (1), Intent (In) :: jceval
C Header Interface
#include <nag.h>
void  d02nsf_ (const Integer *neq, const Integer *neqmax, const char *jceval, const Integer *nwkjac, double rwork[], Integer *ifail, const Charlen length_jceval)
The routine may be called by the names d02nsf or nagf_ode_ivp_stiff_fulljac_setup.

3 Description

d02nsf defines the linear algebra to be used as full matrix linear algebra, permits you to specify the method for calculating the Jacobian and checks the validity of certain input values.

4 References

See the D02M–N Sub-chapter Introduction.

5 Arguments

1: neq Integer Input
On entry: the number of differential equations.
Constraint: 1neqneqmax.
2: neqmax Integer Input
On entry: a bound on the maximum number of differential equations to be solved during the integration.
Constraint: neqmaxneq.
3: jceval Character(1) Input
On entry: specifies the technique to be used to compute the Jacobian.
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 d02nbf or d02ngf must be either d02nbz or d02ngz respectively.
You must supply a (sub)program to evaluate the Jacobian on a call to the integrator.
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 d02nsf; hence it is permissible for the actual argument to be more descriptive ‘Numerical’, ‘Analytical’ or ‘Default’ on a call to d02nsf.
Constraint: jceval='N', 'A' or 'D'.
4: nwkjac Integer Input
On entry: the size of the workspace array wkjac, which you are supplying to the integrator, as declared in the (sub)program from which d02nsf is called.
Constraint: nwkjacneqmax×(neqmax+1).
5: rwork(50+4×neqmax) Real (Kind=nag_wp) array Communication 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.
6: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. When the value -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry ifail=0 or −1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
On entry, jceval=value.
Constraint: jceval='A', 'N' or 'D'.
On entry, neq=value.
Constraint: neq1.
On entry, neq=value and neqmax=value.
Constraint: neqneqmax.
On entry, neqmax=value.
Constraint: neqmax1.
On entry, nwkjac=value and neqmax=value.
Constraint: nwkjac(neqmax+1)×neqmax.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
d02nsf is not thread safe and should not be called from a multithreaded user program. Please see Section 1 in FL Interface Multithreading for more information on thread safety.
d02nsf is not threaded in any implementation.

9 Further Comments

d02nsf must be called as a setup routine before a call to either d02nbf or d02ngf and may be called as the linear algebra setup routine before a call to either d02nmf or d02nnf.

10 Example

See Section 10 in d02nbf, d02ngf and d02nmf.