dcgmrhs

Developer Reference for Intel® oneAPI Math Kernel Library for C

Download PDF

ID 766684

Date 7/13/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-FFB4E4BD-2EB7-43EF-9522-79710A21315B

View Details

dcgmrhs

Computes the approximate solution vectors.

Syntax

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

Include Files

mkl.h

Description

The routine dcgmrhs computes approximate solution vectors using the CG with multiple right-hand sides (MRHS) method [Young71]. The routine dcgmrhs uses the value that was in the x before the first call as an initial approximation to the solution. The parameter RCI_request gives information about task completion status and requests results of certain operations that are required by the solver.

Note that lengths of all vectors are assumed to have been defined in a previous call to the dcgmrhs_init routine.

Input Parameters

n: Sets the size of the problem, and the sizes of arrays x and b.
x: Array of size n*nrhs. Contains the initial approximation to the solution vectors.
nrhs: Sets the number of right-hand sides.
b: Array of size n*nrhs. Contains the right-hand side vectors.
tmp: Array of size (n, 3+nrhs). Refer to the CG Common Parameters.

Output Parameters

RCI_request: Gives information about result of work of the routine.
x: Array of size (n*nrhs). Contains the updated approximation to the solution vectors.
ipar: Array of size (128+2*nrhs). Refer to the CG Common Parameters.
dpar: Array of size (128+2*nrhs). Refer to the CG Common Parameters.
tmp: Array of size (n*(3+nrhs)). Refer to the CG Common Parameters.

Return Values

RCI_request=0: Indicates that the task completed normally and the solution is found and stored in the vector x. This occurs only if the stopping tests are fully automatic. For the user defined stopping tests, see the description of the RCI_request= 2.
RCI_request=-1: Indicates that the routine was interrupted because the maximum number of iterations was reached, but the relative stopping criterion was not met. This situation occurs only if both tests are requested by the user.
RCI_request=-2: The routine was interrupted because of an attempt to divide by zero. This situation happens if the matrix is non-positive definite or almost non-positive definite.
RCI_request=- 10: Indicates that the routine was interrupted because the residual norm is invalid. This usually happens because the value dpar[5] was altered outside of the routine, or the dcg_check routine was not called.
RCI_request=-11: Indicates that the routine was interrupted because it enters the infinite cycle. This usually happens because the values ipar[7], ipar[8], ipar[9] were altered outside of the routine, or the dcg_check routine was not called.
RCI_request= 1: Indicates that you must multiply the matrix by tmp[0:n - 1], put the result in the tmp[n:2*n - 1], and return control back to the routine dcg.
RCI_request= 2: Indicates that you must perform the stopping tests. If they fail, return control back to the dcg routine. Otherwise, the solution is found and stored in the vector x.
RCI_request= 3: Indicates that you must apply the preconditioner to tmp[2*n:3*n - 1], put the result in the tmp[3*n:4*n - 1], and return control back to the routine dcg.

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

dcgmrhs

Syntax

Include Files

Description

Input Parameters

Output Parameters

Return Values