naginterfaces.library.opt.uncon_​conjgrd_​option_​string

naginterfaces.library.opt.uncon_conjgrd_option_string(optstr, comm, io_manager=None)[source]

uncon_conjgrd_option_string may be used to supply individual options to uncon_conjgrd_comp().

Deprecated since version 27.0.0.0: uncon_conjgrd_option_string is deprecated. There is no suggested replacement for this routine.

For full information please refer to the NAG Library document for e04dk

https://www.nag.com/numeric/nl/nagdoc_28.5/flhtml/e04/e04dkf.html

Parameters
optstrstr

A single valid option string (as described in Notes and in Other Parameters for uncon_conjgrd_comp).

commdict, communication object, modified in place

Communication structure.

This argument must have been initialized by a prior call to nlp1_init().

io_managerFileObjManager, optional

Manager for I/O in this routine.

Raises
NagValueError
(errno )

The supplied option string is invalid. Supplied value was: .

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

uncon_conjgrd_option_string may be used to supply values for options to uncon_conjgrd_comp(). It is only necessary to call uncon_conjgrd_option_string for those arguments whose values are to be different from their default values. One call to uncon_conjgrd_option_string sets one argument value.

Each option is defined by a single character string, of up to 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 option. 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 int or float value. Such numbers may be up to 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.

Printing of user-specified options is turned off by default. It may be turned on at any time using the keyword ‘List’.

Option settings are preserved following a call to uncon_conjgrd_comp() and so the keyword ‘Defaults’ is provided to allow you to reset all the options to their default values before a subsequent call to uncon_conjgrd_comp().

A complete list of options, their abbreviations, synonyms and default values is given in Other Parameters for uncon_conjgrd_comp.