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

Fast Poisson Solver Interface Description

All numerical types in this section are either standard C types float and double or MKL_INT integer type. For more information on the C types, refer to C Datatypes Specific to oneMKL and the Intel® oneAPI Math Kernel Library (oneMKL) Developer Guide. To better understand usage of the types, see examples in the examples\pdepoissonc\source folderin your Intel® oneAPI Math Kernel Library (oneMKL) directory.

Routine Options

All Poisson Solver routines use parameters for passing various options to the routines. These parameters are arrays ipar, dpar, and spar. Values for these parameters should be specified very carefully (see Common Parameters). You can change these values during computations to meet your needs. For more details, see the descriptions of specific routines.

warning:

To avoid failure or incorrect results, you must provide correct and consistent parameters to the routines.

User Data Arrays

Poisson Solver routines take arrays of user data as input. For example, the d_Helmholtz_3Droutine takes user arrays to compute an approximate solution to the 3D Helmholtz problem. To minimize storage requirements and improve the overall run-time efficiency, Intel® oneAPI Math Kernel Library (oneMKL) Poisson Solver routines do not make copies of user input arrays.

NOTE:

If you need a copy of your input data arrays, you must save them yourself.

For better performance, align your data arrays as recommended in the Intel® oneAPI Math Kernel Library (oneMKL) Developer Guide (search the document for coding techniques to improve performance).