• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#ifndef EIGEN_SUPERLUSUPPORT_MODULE_H
2#define EIGEN_SUPERLUSUPPORT_MODULE_H
3
4#include "SparseCore"
5
6#include "src/Core/util/DisableStupidWarnings.h"
7
8#ifdef EMPTY
9#define EIGEN_EMPTY_WAS_ALREADY_DEFINED
10#endif
11
12typedef int int_t;
13#include <slu_Cnames.h>
14#include <supermatrix.h>
15#include <slu_util.h>
16
17// slu_util.h defines a preprocessor token named EMPTY which is really polluting,
18// so we remove it in favor of a SUPERLU_EMPTY token.
19// If EMPTY was already defined then we don't undef it.
20
21#if defined(EIGEN_EMPTY_WAS_ALREADY_DEFINED)
22# undef EIGEN_EMPTY_WAS_ALREADY_DEFINED
23#elif defined(EMPTY)
24# undef EMPTY
25#endif
26
27#define SUPERLU_EMPTY (-1)
28
29namespace Eigen { struct SluMatrix; }
30
31/** \ingroup Support_modules
32  * \defgroup SuperLUSupport_Module SuperLUSupport module
33  *
34  * This module provides an interface to the <a href="http://crd-legacy.lbl.gov/~xiaoye/SuperLU/">SuperLU</a> library.
35  * It provides the following factorization class:
36  * - class SuperLU: a supernodal sequential LU factorization.
37  * - class SuperILU: a supernodal sequential incomplete LU factorization (to be used as a preconditioner for iterative methods).
38  *
39  * \warning When including this module, you have to use SUPERLU_EMPTY instead of EMPTY which is no longer defined because it is too polluting.
40  *
41  * \code
42  * #include <Eigen/SuperLUSupport>
43  * \endcode
44  *
45  * In order to use this module, the superlu headers must be accessible from the include paths, and your binary must be linked to the superlu library and its dependencies.
46  * The dependencies depend on how superlu has been compiled.
47  * For a cmake based project, you can use our FindSuperLU.cmake module to help you in this task.
48  *
49  */
50
51#include "src/misc/Solve.h"
52#include "src/misc/SparseSolve.h"
53
54#include "src/SuperLUSupport/SuperLUSupport.h"
55
56
57#include "src/Core/util/ReenableStupidWarnings.h"
58
59#endif // EIGEN_SUPERLUSUPPORT_MODULE_H
60