Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

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

Document Table of Contents

dfgmres_init

Initializes the solver.

Syntax

void dfgmres_init (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_initinitializes the solver. After initialization all subsequent invocations of Intel® oneAPI Math Kernel Library (oneMKL) RCI FGMRES routines use the values of all parameters that are returned bydfgmres_init. Advanced users can skip this step and set the values in the ipar and dpar arrays directly.

warning:

You can modify the contents of these arrays after they are passed to the solver routine only if you are sure that the values are correct and consistent. You can perform a basic check for correctness and consistency by calling the dfgmres_check routine, but it does not guarantee that the method will work correctly.

Input 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 the result of the routine.

ipar

Array of size 128. Refer to the FGMRES Common Parameters.

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= -10000

Indicates failure to complete the task.