Developer Reference for Intel® oneAPI Math Kernel Library for Fortran

ID 766686
Date 3/31/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

dcgmrhs_check

Checks consistency and correctness of the user defined data.

Syntax

dcgmrhs_check(n, x, nrhs, b, RCI_request, ipar, dpar, tmp)

Include Files
  • Fortran: mkl_rci.fi, mkl_rci.f90
Description

The routine dcgmrhs_check checks the consistency and correctness of the parameters to be passed to the solver routine dcgmrhs. While this operation reduces the chance of making a mistake in the parameters, it does not guarantee that the solver returns the correct result.

If you are sure that the correct data is specified in the solver parameters, you can skip this operation.

The lengths of all vectors must be defined in a previous call to the dcgmrhs_init routine.

If none of the stopping criteria (ipar(8)-ipar(10)) has been enabled, both ipar(8) and ipar(9) will be set to 1.

Input Parameters
n

INTEGER. Sets the size of the problem.

x

DOUBLE PRECISION. Array of size n*nrhs. Contains the initial approximation to the solution vectors. Normally it is equal to 0 or to b.

nrhs

INTEGER. This parameter sets the number of right-hand sides.

b

DOUBLE PRECISION. Array of size n*nrhs. Contains the right-hand side vectors.

Output Parameters
RCI_request

INTEGER. Returns information about the results of the routine.

ipar

INTEGER. Array of size (128+2*nrhs). Refer to the CG Common Parameters. Only ipar(8)-ipar(9) might be changed.

dpar

DOUBLE PRECISION. Array of size (128+2*nrhs). Refer to the CG Common Parameters.

tmp

DOUBLE PRECISION. Array of size (n, (3+nrhs)). Refer to the CG Common Parameters.

Return Values
RCI_request= 0

Indicates that the task completed normally.

RCI_request= -1100

Indicates that the task is interrupted and the errors occur.

RCI_request= -1001

Indicates that there are some warning messages.

RCI_request= -1010

Indicates that the routine changed some parameters to make them consistent or correct.

RCI_request= -1011

Indicates that there are some warning messages and that the routine changed some parameters.