dfgmres_check

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 11/07/2023

Version

Public

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

Visible to Intel only — GUID: GUID-37F4E928-CC79-4029-9168-FE3EE3450B2B

View Details

dfgmres_check

Checks consistency and correctness of the user defined data.

Syntax

void dfgmres_check (const MKL_INT *n, const double *x, const double *b, MKL_INT *RCI_request, MKL_INT *ipar, double *dpar, double *tmp );

Include Files

mkl.h

Description

The routine dfgmres_check checks consistency and correctness of the parameters to be passed to the solver routine dfgmres. However, this operation does not guarantee that the method gives the correct result. It only reduces the chance of making a mistake in the parameters of the routine. Skip this operation only if you are sure that the correct data is specified in the solver parameters.

The lengths of all vectors are assumed to have been defined in a previous call to the dfgmres_init routine.

In particular, the routine checks the consistency of ipar[15]-ipar[20] and ipar[0], ipar[14]. If the values do not agree, the routine emits a warning and modifies ipar[15]-ipar[20] to comply with the values of ipar[0], ipar[14]. A possible use case for this modification is a non-default value (not the one set by a possible call to dfgmres_init) of ipar[14].

Also, if none of the stopping criteria (ipar[7]-ipar[9]) has been enabled, both ipar[7] and ipar[9] will be set to 1.

NOTE: It is not strictly necessary to call the dfgmres_check routine unless the values of ipar[14] or ipar[0] are changed after the last call to dfgmres_init.

Input Parameters

ipar: Array of size 128. Refer to the FGMRES Common Parameters.
n: Sets the size of the problem.
x: Array of size n. Contains the initial approximation to the solution vector. Normally it is equal to 0 or to b.
b: Array of size n. Contains the right-hand side vector.

Output Parameters

RCI_request: Gives information about result of the routine.
ipar: Array of size 128. Refer to the FGMRES Common Parameters. Only ipar[7]-ipar[8] and ipar[15]-ipar[20] might be changed.
dpar: Array of size 128. Refer to the FGMRES Common Parameters.
tmp: Array of size ((2*ipar[14] + 1)*n + ipar[14]*(ipar[14] + 9)/2 + 1). Refer to the FGMRES 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.

Parent topic: RCI ISS Routines

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Developer Reference for Intel® oneAPI Math Kernel Library for C

dfgmres_check

Syntax

Include Files

Description

Input Parameters

Output Parameters

Return Values