PaStiXSupport 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. // This file is part of Eigen, a lightweight C++ template library
  2. // for linear algebra.
  3. //
  4. // This Source Code Form is subject to the terms of the Mozilla
  5. // Public License v. 2.0. If a copy of the MPL was not distributed
  6. // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
  7. #ifndef EIGEN_PASTIXSUPPORT_MODULE_H
  8. #define EIGEN_PASTIXSUPPORT_MODULE_H
  9. #include "SparseCore"
  10. #include "src/Core/util/DisableStupidWarnings.h"
  11. extern "C" {
  12. #include <pastix_nompi.h>
  13. #include <pastix.h>
  14. }
  15. #ifdef complex
  16. #undef complex
  17. #endif
  18. /** \ingroup Support_modules
  19. * \defgroup PaStiXSupport_Module PaStiXSupport module
  20. *
  21. * This module provides an interface to the <a href="http://pastix.gforge.inria.fr/">PaSTiX</a> library.
  22. * PaSTiX is a general \b supernodal, \b parallel and \b opensource sparse solver.
  23. * It provides the two following main factorization classes:
  24. * - class PastixLLT : a supernodal, parallel LLt Cholesky factorization.
  25. * - class PastixLDLT: a supernodal, parallel LDLt Cholesky factorization.
  26. * - class PastixLU : a supernodal, parallel LU factorization (optimized for a symmetric pattern).
  27. *
  28. * \code
  29. * #include <Eigen/PaStiXSupport>
  30. * \endcode
  31. *
  32. * In order to use this module, the PaSTiX headers must be accessible from the include paths, and your binary must be linked to the PaSTiX library and its dependencies.
  33. * This wrapper resuires PaStiX version 5.x compiled without MPI support.
  34. * The dependencies depend on how PaSTiX has been compiled.
  35. * For a cmake based project, you can use our FindPaSTiX.cmake module to help you in this task.
  36. *
  37. */
  38. #include "src/PaStiXSupport/PaStiXSupport.h"
  39. #include "src/Core/util/ReenableStupidWarnings.h"
  40. #endif // EIGEN_PASTIXSUPPORT_MODULE_H