NAG Library Routine Document

E04UJF/E04UJA

+− Contents

1 Purpose

+− 2 Specification

2.1 Specification for E04UJF

2.2 Specification for E04UJA

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Further Comments

9 Example

1 Purpose

To supply individual optional parameters to E04UGF/E04UGA. More precisely, E04UJF must be used to supply optional parameters to E04UGF and E04UJA must be used to supply optional parameters to E04UGA.

E04UJA is a version of E04UJF that has additional parameters in order to make it safe for use in multithreaded applications (see Section 5). The initialization routine E04WBF must have been called before calling E04UJA.

2 Specification

2.1 Specification for E04UJF

SUBROUTINE E04UJF (

STR)

CHARACTER(*)

STR

2.2 Specification for E04UJA

SUBROUTINE E04UJA (

STR, LWSAV, IWSAV, RWSAV, INFORM)

INTEGER	IWSAV(550), INFORM
REAL (KIND=nag_wp)	RWSAV(550)
LOGICAL	LWSAV(20)
CHARACTER(*)	STR

3 Description

E04UJF/E04UJA may be used to supply values for optional parameters to E04UGF/E04UGA. It is only necessary to call E04UJF/E04UJA for those parameters whose values are to be different from their default values. One call to E04UJF/E04UJA sets one parameter value.

Each optional parameter is defined by a single character string, of up to

72

characters, consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs

[=]

. Alphabetic characters may be upper or lower case. The string

Print Level = 1

is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:

–	a mandatory keyword;
–	a phrase that qualifies the keyword;
–	a number that specifies an integer or real value. Such numbers may be up to $16$ contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.

Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.

For E04UJF, each user-specified option is normally printed as it is defined, on the current advisory message unit (see X04ABF), but this printing may be suppressed using the keyword Nolist. Thus the statement

 
 CALL E04UJF ('Nolist')

suppresses printing of this and subsequent options. Printing will automatically be turned on again after a call to E04UGF and may be turned on again at any time using the keyword List.

For E04UJA printing is turned off by default, but may be turned on at any time using the keyword List.

Optional parameter settings are preserved following a call to E04UGF/E04UGA and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to E04UGF/E04UGA.

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 11 in E04UGF/E04UGA.

4 References

None.

5 Parameters

1: STR – CHARACTER(*)Input: On entry: a single valid option string (as described in Section 3 and in Section 11 in E04UGF/E04UGA).; Note: the following are additional parameters for specific use with E04UJA. Users of E04UJF therefore need not read the remainder of this description.
2: LWSAV( $20$ ) – LOGICAL arrayCommunication Array
3: IWSAV( $550$ ) – INTEGER arrayCommunication Array
4: RWSAV( $550$ ) – REAL (KIND=nag_wp) arrayCommunication Array: The arrays LWSAV, IWSAV and RWSAV must not be altered between calls to any of the routines E04UJA, E04UGA, E04UHA or E04WBF.
5: INFORM – INTEGEROutput: On exit: contains zero if a valid option string has been supplied and a $value > 0$ otherwise (see Section 6).

6 Error Indicators and Warnings

Errors or warnings detected by the routine:

$INFORM = 5$: The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.

7 Accuracy

Not applicable.

8 Further Comments

E04UHF/E04UHA may also be used to supply optional parameters to E04UGF/E04UGA.

9 Example

See Section 9 in E04UHF/E04UHA.

E04UJF/E04UJA (PDF version)

E04 Chapter Contents

E04 Chapter Introduction

NAG Library Manual

NAG Library Routine DocumentE04UJF/E04UJA