NAG Library Routine Document

e05jaf (bnd_mcs_init)

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1
Purpose

e05jaf is used to initialize communication data for the suite of multi-level coordinate search routines: e05jbf, e05jcf, e05jdf, e05jef, e05jff, e05jgf, e05jhf, e05jjf, e05jkf and e05jlf.

2
Specification

Fortran Interface
Subroutine e05jaf ( n_r, comm, lcomm, ifail)
Integer, Intent (In):: n_r, lcomm
Integer, Intent (Inout):: ifail
Real (Kind=nag_wp), Intent (Out):: comm(lcomm)
C Header Interface
#include nagmk26.h
void  e05jaf_ (Integer *n_r, double comm[], const Integer *lcomm, Integer *ifail)

3
Description

e05jaf initializes the communication array comm for the solver e05jbf and the optional-argument handlers e05jcf, e05jdf, e05jef, e05jff, e05jgf, e05jhf, e05jjf, e05jkf and e05jlf.

4
References

None.

5
Arguments

1:     n_r – IntegerDummy
This argument is no longer accessed by e05jaf.
2:     commlcomm – Real (Kind=nag_wp) arrayCommunication Array
On exit: comm must not be altered between calls to any of the routines e05jbf, e05jcf, e05jdf, e05jef, e05jff, e05jgf, e05jhf, e05jjf, e05jkf and e05jlf.
3:     lcomm – IntegerInput
On entry: the dimension of the array comm as declared in the (sub)program from which e05jaf is called.
Constraint: lcomm100.
4:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ 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​ 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 -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:
ifail=1
On entry, lcomm=value.
Constraint: lcomm100.
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.
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.
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

Not applicable.

8
Parallelism and Performance

e05jaf is threaded by NAG for parallel execution in multithreaded implementations of the NAG Library.
Please consult the X06 Chapter Introduction for information on how to control and interrogate the OpenMP environment used within this routine. Please also consult the Users' Note for your implementation for any additional implementation-specific information.

9
Further Comments

The time taken by e05jaf is negligible.

10
Example

See Section 10 in e05jbf and e05jcf.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017